Auki::ConjureKit::ECS::PoseSystem
Inherits from Auki.ConjureKit.ECS.SystemBase, Auki.ConjureKit.ECS.IPoseSystem, Auki.ConjureKit.ECS.ISystem
Public Events
Name | |
---|---|
Action< Entity > | OnEntityUpdatePose() |
Public Functions
Name | |
---|---|
void | SetParticipantPoseUpdatesPerSecond(int participantPoseUpdatesPerSecond) Sets the amount of times the participant's pose should be updated per second. |
int | GetParticipantPoseUpdatesPerSecond() |
void | AddEntityPose(uint entityId, Pose pose, Action onComplete, Action< string > onError) Adds a Pose to an existing entity. This will attach a new component of auki.pose to the given entity. |
bool | UpdateEntityPose(uint entityId, Pose pose) Tries to update the Pose of an existing entity. |
Pose | GetEntityPose(uint entityId) Queries the Pose of a specific entity. |
Pose | GetEntityPose(Entity entity) Queries the Pose of a specific entity. the entity Pose, ff entity has an auki.pose component attached. |
virtual override string[] | GetComponentTypeNames() Will be invoked by ConjureKit and has to return an array of all component type names that the System will use. |
virtual override void | Update(IReadOnlyList<(EntityComponent component, bool localChange)> updated) Invoked by ConjureKit when EntityComponents are altered. |
virtual override void | Delete(IReadOnlyList<(EntityComponent component, bool localChange)> deleted) Invoked by ConjureKit when EntityComponent are removed. |
Public Attributes
Name | |
---|---|
const string | AUKI_SYSTEM_POSE_COMPONENT_NAME Component type used by PoseSystem |
Additional inherited members
Protected Functions inherited from Auki.ConjureKit.ECS.SystemBase
Name | |
---|---|
SystemBase(Session session) System constructor with session instance |
Protected Attributes inherited from Auki.ConjureKit.ECS.SystemBase
Name | |
---|---|
readonly Session | _session Session instance used by the system. |
Public Events Documentation
event OnEntityUpdatePose
Action< Entity > OnEntityUpdatePose()
Public Functions Documentation
function SetParticipantPoseUpdatesPerSecond
void SetParticipantPoseUpdatesPerSecond(
int participantPoseUpdatesPerSecond
)
Sets the amount of times the participant's pose should be updated per second.
function GetParticipantPoseUpdatesPerSecond
int GetParticipantPoseUpdatesPerSecond()
Return: The amount of times the participant's pose updates per second.
function AddEntityPose
void AddEntityPose(
uint entityId,
Pose pose,
Action onComplete,
Action< string > onError
)
Adds a Pose to an existing entity. This will attach a new component of auki.pose
to the given entity.
Reimplements: Auki::ConjureKit::ECS::IPoseSystem::AddEntityPose
function UpdateEntityPose
bool UpdateEntityPose(
uint entityId,
Pose pose
)
Tries to update the Pose of an existing entity.
Reimplements: Auki::ConjureKit::ECS::IPoseSystem::UpdateEntityPose
function GetEntityPose
Pose GetEntityPose(
uint entityId
)
Queries the Pose of a specific entity.
Reimplements: Auki::ConjureKit::ECS::IPoseSystem::GetEntityPose
function GetEntityPose
Pose GetEntityPose(
Entity entity
)
Queries the Pose of a specific entity. the entity Pose, ff entity has an auki.pose
component attached.
Reimplements: Auki::ConjureKit::ECS::IPoseSystem::GetEntityPose
function GetComponentTypeNames
virtual override string[] GetComponentTypeNames()
Will be invoked by ConjureKit and has to return an array of all component type names that the System will use.
Reimplements: Auki::ConjureKit::ECS::SystemBase::GetComponentTypeNames
function Update
virtual override void Update(
IReadOnlyList<(EntityComponent component, bool localChange)> updated
)
Invoked by ConjureKit when EntityComponents are altered.
Reimplements: Auki::ConjureKit::ECS::SystemBase::Update
function Delete
virtual override void Delete(
IReadOnlyList<(EntityComponent component, bool localChange)> deleted
)
Invoked by ConjureKit when EntityComponent are removed.
Reimplements: Auki::ConjureKit::ECS::SystemBase::Delete
Public Attributes Documentation
variable AUKI_SYSTEM_POSE_COMPONENT_NAME
static const string AUKI_SYSTEM_POSE_COMPONENT_NAME = "auki.pose";
Component type used by PoseSystem