Open 3D Engine EMotionFX Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | Static Public Attributes | List of all members
EMotionFX::Integration::ActorComponentRequests Class Referenceabstract

#include <ActorComponentBus.h>

Inherits AZ::ComponentBus.

Public Types

using MutexType = AZStd::recursive_mutex
 

Public Member Functions

virtual EMotionFX::ActorInstance * GetActorInstance ()
 
virtual size_t GetNumJoints () const
 Retrieve the total number of joints.
 
virtual size_t GetJointIndexByName (const char *) const
 
virtual AZ::Transform GetJointTransform (size_t, Space) const
 
virtual void GetJointTransformComponents (size_t, Space, AZ::Vector3 &outPosition, AZ::Quaternion &outRotation, AZ::Vector3 &outScale) const
 
virtual Physics::AnimationConfiguration * GetPhysicsConfig () const
 
virtual void AttachToEntity (AZ::EntityId, AttachmentType)
 
virtual void DetachFromEntity ()
 Detach from parent entity, if attached.
 
virtual bool GetRenderCharacter () const =0
 Enables rendering of the actor.
 
virtual void SetRenderCharacter (bool enable)=0
 
virtual bool GetRenderActorVisible () const =0
 
virtual SkinningMethod GetSkinningMethod () const =0
 Returns skinning method used by the actor.
 
virtual void SetActorAsset (AZ::Data::Asset< EMotionFX::Integration::ActorAsset > actorAsset)=0
 
virtual void EnableInstanceUpdate (bool enableInstanceUpdate)=0
 

Static Public Attributes

static const size_t s_invalidJointIndex = std::numeric_limits<size_t>::max()
 

Detailed Description

EMotion FX Actor Component Request Bus Used for making requests to EMotion FX Actor Components.

Member Function Documentation

◆ AttachToEntity()

virtual void EMotionFX::Integration::ActorComponentRequests::AttachToEntity ( AZ::EntityId  ,
AttachmentType   
)
inlinevirtual

Attach to the specified entity.

Parameters
targetEntityId- Id of the entity to attach to.
attachmentType- Desired type of attachment.

◆ GetActorInstance()

virtual EMotionFX::ActorInstance * EMotionFX::Integration::ActorComponentRequests::GetActorInstance ( )
inlinevirtual

Retrieve component's actor instance.

Returns
pointer to actor instance.

◆ GetJointIndexByName()

virtual size_t EMotionFX::Integration::ActorComponentRequests::GetJointIndexByName ( const char *  ) const
inlinevirtual

Find the name index of a given joint by its name.

Parameters
nameThe name of the join to search for, case insensitive.
Returns
The joint index, or s_invalidJointIndex if no found.

◆ GetJointTransform()

virtual AZ::Transform EMotionFX::Integration::ActorComponentRequests::GetJointTransform ( size_t  ,
Space   
) const
inlinevirtual

Retrieve the local transform (relative to the parent) of a given joint.

Parameters
jointIndexThe joint index to get the transform from.
Spacethe space to get the transform in.
The documentation for this class was generated from the following file: