Space Engineers
Public Member Functions | Public Attributes | Properties | Events | List of all members
VRage.Game.Components.MyAnimationControllerComponent Class Reference

Entity component containing animation controller. More...

Inheritance diagram for VRage.Game.Components.MyAnimationControllerComponent:
VRage.Game.Components.MyEntityComponentBase VRage.Game.Components.MyComponentBase

Public Member Functions

override void OnAddedToContainer ()
 Component was added in the entity component container. More...
 
override void OnBeforeRemovedFromContainer ()
 Component will be removed from entity component container. More...
 
void MarkAsValid ()
 
void MarkAsInvalid ()
 
void SetCharacterBones (MyCharacterBone[] characterBones, Matrix[] relativeTransforms, Matrix[] abosoluteTransforms)
 
void Update ()
 
void UpdateTransformations ()
 
void UpdateInverseKinematics ()
 
VRageRender.Animations.MyCharacterBone FindBone (string name, out int index)
 
void TriggerAction (MyStringId actionName)
 Trigger an action in this layer. If there is a transition having given (non-null) name, it is followed immediatelly. Conditions of transition are ignored. This is a shortcut to Controller.TriggerAction. More...
 
void Clear ()
 
- Public Member Functions inherited from VRage.Game.Components.MyComponentBase
virtual void SetContainer (MyComponentContainer container)
 Sets the container of this component. Note that the component is not added to the container here! Therefore, use MyComponentContainer.Add(...) method and it will in turn call this method. Actually, you should seldom have the need to call this method yourself. More...
 
virtual T GetAs< T > ()
 
virtual void OnAddedToScene ()
 CH: TOOD: Be careful! This does not get called if the component is added to a container that is in the scene already! More...
 
virtual void OnRemovedFromScene ()
 CH: TOOD: Be careful! This does not get called if the component is removed from a container that is still in the scene! More...
 
virtual MyObjectBuilder_ComponentBase Serialize (bool copy=false)
 
virtual void Deserialize (MyObjectBuilder_ComponentBase builder)
 
virtual void Init (MyComponentDefinitionBase definition)
 
virtual bool IsSerialized ()
 Tells the component container serializer whether this component should be saved More...
 

Public Attributes

Action ReloadBonesNeeded
 

Properties

override string ComponentTypeDebugString [get]
 Name of the component type for debug purposes (e.g.: "Position") More...
 
VRageRender.Animations.MyAnimationController Controller [get]
 Get the animation controller instance. More...
 
MyAnimationVariableStorage Variables [get]
 Get the variable storage of animation controller instance. Shortcut. More...
 
MyCharacterBone[] CharacterBones [get]
 Get reference to array of character bones and its contents. More...
 
MyAnimationInverseKinematics InverseKinematics [get]
 Get the instance of inverse kinematics. More...
 
VRageRender.Animations.MyCharacterBone[] CharacterBonesSorted [get]
 
Matrix[] BoneRelativeTransforms [get]
 
Matrix[] BoneAbsoluteTransforms [get]
 
List< MyAnimationClip.BoneStateLastRawBoneResult [get]
 
MyDefinitionId SourceId [get, set]
 
List< MyStringIdLastFrameActions [get]
 
- Properties inherited from VRage.Game.Components.MyEntityComponentBase
MyEntityComponentContainer Container [get]
 
IMyEntity Entity [get]
 
abstract string ComponentTypeDebugString [get]
 Name of the base component type for debug purposes (e.g.: "Position") More...
 
- Properties inherited from VRage.Game.Components.MyComponentBase
MyComponentContainer ContainerBase [get]
 This cannot be named Container to not conflict with the definition of Container in MyEntityComponentBase. More...
 

Events

Action< MyStringIdActionTriggered
 
- Events inherited from VRage.Game.Components.MyEntityComponentBase
static Action< MyEntityComponentBaseOnAfterAddedToContainer
 
Action< MyEntityComponentBaseBeforeRemovedFromContainer
 

Detailed Description

Entity component containing animation controller.

Definition at line 13 of file MyAnimationControllerComponent.cs.

Member Function Documentation

void VRage.Game.Components.MyAnimationControllerComponent.Clear ( )
inline

Definition at line 250 of file MyAnimationControllerComponent.cs.

VRageRender.Animations.MyCharacterBone VRage.Game.Components.MyAnimationControllerComponent.FindBone ( string  name,
out int  index 
)
inline

Definition at line 203 of file MyAnimationControllerComponent.cs.

void VRage.Game.Components.MyAnimationControllerComponent.MarkAsInvalid ( )
inline

Definition at line 72 of file MyAnimationControllerComponent.cs.

void VRage.Game.Components.MyAnimationControllerComponent.MarkAsValid ( )
inline

Definition at line 64 of file MyAnimationControllerComponent.cs.

override void VRage.Game.Components.MyAnimationControllerComponent.OnAddedToContainer ( )
inlinevirtual

Component was added in the entity component container.

Reimplemented from VRage.Game.Components.MyEntityComponentBase.

Definition at line 51 of file MyAnimationControllerComponent.cs.

override void VRage.Game.Components.MyAnimationControllerComponent.OnBeforeRemovedFromContainer ( )
inlinevirtual

Component will be removed from entity component container.

Reimplemented from VRage.Game.Components.MyEntityComponentBase.

Definition at line 59 of file MyAnimationControllerComponent.cs.

void VRage.Game.Components.MyAnimationControllerComponent.SetCharacterBones ( MyCharacterBone[]  characterBones,
Matrix[]  relativeTransforms,
Matrix[]  abosoluteTransforms 
)
inline

Definition at line 137 of file MyAnimationControllerComponent.cs.

void VRage.Game.Components.MyAnimationControllerComponent.TriggerAction ( MyStringId  actionName)
inline

Trigger an action in this layer. If there is a transition having given (non-null) name, it is followed immediatelly. Conditions of transition are ignored. This is a shortcut to Controller.TriggerAction.

Definition at line 231 of file MyAnimationControllerComponent.cs.

void VRage.Game.Components.MyAnimationControllerComponent.Update ( )
inline

Definition at line 154 of file MyAnimationControllerComponent.cs.

void VRage.Game.Components.MyAnimationControllerComponent.UpdateInverseKinematics ( )
inline

Definition at line 196 of file MyAnimationControllerComponent.cs.

void VRage.Game.Components.MyAnimationControllerComponent.UpdateTransformations ( )
inline

Definition at line 188 of file MyAnimationControllerComponent.cs.

Member Data Documentation

Action VRage.Game.Components.MyAnimationControllerComponent.ReloadBonesNeeded

Definition at line 37 of file MyAnimationControllerComponent.cs.

Property Documentation

Matrix [] VRage.Game.Components.MyAnimationControllerComponent.BoneAbsoluteTransforms
get

Definition at line 119 of file MyAnimationControllerComponent.cs.

Matrix [] VRage.Game.Components.MyAnimationControllerComponent.BoneRelativeTransforms
get

Definition at line 117 of file MyAnimationControllerComponent.cs.

MyCharacterBone [] VRage.Game.Components.MyAnimationControllerComponent.CharacterBones
get

Get reference to array of character bones and its contents.

Definition at line 102 of file MyAnimationControllerComponent.cs.

VRageRender.Animations.MyCharacterBone [] VRage.Game.Components.MyAnimationControllerComponent.CharacterBonesSorted
get

Definition at line 114 of file MyAnimationControllerComponent.cs.

override string VRage.Game.Components.MyAnimationControllerComponent.ComponentTypeDebugString
get

Name of the component type for debug purposes (e.g.: "Position")

Definition at line 46 of file MyAnimationControllerComponent.cs.

VRageRender.Animations.MyAnimationController VRage.Game.Components.MyAnimationControllerComponent.Controller
get

Get the animation controller instance.

Definition at line 86 of file MyAnimationControllerComponent.cs.

MyAnimationInverseKinematics VRage.Game.Components.MyAnimationControllerComponent.InverseKinematics
get

Get the instance of inverse kinematics.

Definition at line 110 of file MyAnimationControllerComponent.cs.

List<MyStringId> VRage.Game.Components.MyAnimationControllerComponent.LastFrameActions
get

Definition at line 126 of file MyAnimationControllerComponent.cs.

List<MyAnimationClip.BoneState> VRage.Game.Components.MyAnimationControllerComponent.LastRawBoneResult
get

Definition at line 121 of file MyAnimationControllerComponent.cs.

MyDefinitionId VRage.Game.Components.MyAnimationControllerComponent.SourceId
getset

Definition at line 123 of file MyAnimationControllerComponent.cs.

MyAnimationVariableStorage VRage.Game.Components.MyAnimationControllerComponent.Variables
get

Get the variable storage of animation controller instance. Shortcut.

Definition at line 94 of file MyAnimationControllerComponent.cs.

Event Documentation

Action<MyStringId> VRage.Game.Components.MyAnimationControllerComponent.ActionTriggered

Definition at line 39 of file MyAnimationControllerComponent.cs.


The documentation for this class was generated from the following file: