Banshee Engine Docs

class Bone

Inherits: Component

Component that maps animation for specific bone also be applied to the SceneObject this component is attached to.

The component will attach to the first found parent Animation component.

Public

Constructors

Bone

Bone(const HSceneObject &parent)

Methods

~Bone

virtual ~Bone() noexcept = default

SetBoneName

void SetBoneName(const String &name)

Determines the name of the bone the component is referencing.

GetBoneName

const String &GetBoneName() const

staticGetRttiStatic

static RTTIType *GetRttiStatic()

GetRtti

RTTIType *GetRtti() const

Returns an interface you can use to access class' Run Time Type Information.

Internal

Methods

SetParentAnimation

void SetParentAnimation(const HAnimation &animation, bool isInternal = false)

Changes the parent animation of this component.

animation
New animation parent, can be null.
isInternal
If true the bone will just be changed internally, but parent animation will not be notified.

Protected

Constructors

Bone

Bone()

Methods

OnDestroyed

void OnDestroyed()

Called once just before the component is destroyed.

Called regardless of the state the component is in.

OnDisabled

void OnDisabled()

Called every time a component is placed into the Stopped state.

This includes component destruction if component wasn't already in Stopped state during destruction. When called during destruction it is called before OnDestroyed.

OnEnabled

void OnEnabled()

Called every time a component leaves the Stopped state, if the component is enabled.

This includes component creation if requirements for leaving the Stopped state are met. When called during creation it is called after OnBeginPlay.

OnTransformChanged

void OnTransformChanged(TransformChangedFlags flags)

Called when the component's parent scene object has changed.

Not called if the component is in Stopped state. Also only called if necessary notify flags are set via SetNotifyFlagsInternal().

Fields

mBoneName

String mBoneName

mParent

HAnimation mParent

Private

Methods

UpdateParentAnimation

void UpdateParentAnimation()

Attempts to find the parent Animation component and registers itself with it.