HPL3/Amnesia: Rebirth/Scripting/cBoneState

From Frictional Wiki
Jump to navigation Jump to search

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Fields

cBoneState has no public fields.

Functions

Return Type Function And Description
void AddChild(cNode3D@ apChild)
bool AddEntity(iEntity3D@ apEntity)
void AddRotation(const cVector3f &in avRot, eEulerRotationOrder aOrder)
void AddRotation(const cQuaternion &in aqRotation, bool abNormalize = true)
void AddScale(const cVector3f &in avScale)
void AddTranslation(const cVector3f &in avTrans)
void ApplyPostAnimTransform(bool abSetChildrenUpdated)
void ApplyPreAnimTransform(bool abSetChildrenUpdated)
void ClearEntities()
cNode3D CreateChild(const tString &in asName, bool abAutoDeleteChildren = true)
iPhysicsBody GetBody()
cNode3DIterator GetChildIterator()
iPhysicsBody GetColliderBody()
int GetCustomFlags()
cMatrixf GetLocalMatrix()
cVector3f GetLocalPosition()
tString GetName()
cNode3D GetParent()
cMatrixf GetPostAnimTransform()
cMatrixf GetPreAnimTransform()
bool GetUsePostAnimTransform()
bool GetUsePreAnimTransform()
cMatrixf GetWorldMatrix()
cVector3f GetWorldPosition()
bool IsActive()
void NormalizeRotation(float afWeightMul = 1.0f)
void RemoveChild(cNode3D@ apNode)
bool RemoveEntity(iEntity3D@ apEntity)
void SetActive(bool abX)
void SetBody(iPhysicsBody@ apBody)
void SetColliderBody(iPhysicsBody@ apBody)
void SetCustomFlags(int alX)
void SetMatrix(const cMatrixf &in a_mtxTransform, bool abSetChildrenUpdated = true)
void SetParent(cNode3D@ apNode)
void SetPosition(const cVector3f &in avPos)
void SetPostTransform(const cMatrixf &in a_mtxTransform)
void SetPostTransformReversed(bool abX)
void SetPreTransform(const cMatrixf &in a_mtxTransform)
void SetUsePostTransform(bool abX)
void SetUsePreTransform(bool abX)
int SetVisible(bool abX, bool abCascade)
void SetWorldMatrix(const cMatrixf &in a_mtxWorldTransform)
void SetWorldPosition(const cVector3f &in avWorldPos)
void UpdateEntityChildren()
void UpdateMatrix(bool abSetChildrenUpdated)

Details

AddChild

void AddChild(cNode3D@ apChild)


Parameters

Returns:

  • void

AddEntity

bool AddEntity(iEntity3D@ apEntity)


Parameters

Returns:

  • bool

AddRotation

void AddRotation(const cVector3f &in avRot,
                 eEulerRotationOrder aOrder)


Parameters

Returns:

  • void

AddRotation

void AddRotation(const cQuaternion &in aqRotation,
                 bool abNormalize = true)


Parameters

Returns:

  • void

AddScale

void AddScale(const cVector3f &in avScale)


Parameters

Returns:

  • void

AddTranslation

void AddTranslation(const cVector3f &in avTrans)


Parameters

Returns:

  • void

ApplyPostAnimTransform

void ApplyPostAnimTransform(bool abSetChildrenUpdated)


Parameters

  • abSetChildrenUpdated (bool) —

Returns:

  • void

ApplyPreAnimTransform

void ApplyPreAnimTransform(bool abSetChildrenUpdated)


Parameters

  • abSetChildrenUpdated (bool) —

Returns:

  • void

ClearEntities

void ClearEntities()

Returns:

  • void

CreateChild

cNode3D@ CreateChild(const tString &in asName,
                     bool abAutoDeleteChildren = true)


Parameters

  • asName (tString) —
  • abAutoDeleteChildren (bool) —

Returns:

  • cNode3D@

GetBody

iPhysicsBody@ GetBody()

Returns:

  • iPhysicsBody@

GetChildIterator

cNode3DIterator@ GetChildIterator()

Returns:

  • cNode3DIterator@

GetColliderBody

iPhysicsBody@ GetColliderBody()

Returns:

  • iPhysicsBody@

GetCustomFlags

int GetCustomFlags()

Returns:

  • int

GetLocalMatrix

const cMatrixf& GetLocalMatrix()

Returns:

  • const cMatrixf&

GetLocalPosition

cVector3f GetLocalPosition()

Returns:

  • cVector3f

GetName

const tString& GetName()

Returns:

  • const tString&

GetParent

cNode3D@ GetParent()

Returns:

  • cNode3D@

GetPostAnimTransform

const cMatrixf& GetPostAnimTransform()

Returns:

  • const cMatrixf&

GetPreAnimTransform

const cMatrixf& GetPreAnimTransform()

Returns:

  • const cMatrixf&

GetUsePostAnimTransform

bool GetUsePostAnimTransform()

Returns:

  • bool

GetUsePreAnimTransform

bool GetUsePreAnimTransform()

Returns:

  • bool

GetWorldMatrix

const cMatrixf& GetWorldMatrix()

Returns:

  • const cMatrixf&

GetWorldPosition

cVector3f GetWorldPosition()

Returns:

  • cVector3f

IsActive

bool IsActive()

Returns:

  • bool

NormalizeRotation

void NormalizeRotation(float afWeightMul = 1.0f)


Parameters

  • afWeightMul (float) —

Returns:

  • void

RemoveChild

void RemoveChild(cNode3D@ apNode)


Parameters

Returns:

  • void

RemoveEntity

bool RemoveEntity(iEntity3D@ apEntity)


Parameters

Returns:

  • bool

SetActive

void SetActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetBody

void SetBody(iPhysicsBody@ apBody)


Parameters

Returns:

  • void

SetColliderBody

void SetColliderBody(iPhysicsBody@ apBody)


Parameters

Returns:

  • void

SetCustomFlags

void SetCustomFlags(int alX)


Parameters

  • alX (int) —

Returns:

  • void

SetMatrix

void SetMatrix(const cMatrixf &in a_mtxTransform,
               bool abSetChildrenUpdated = true)


Parameters

  • a_mtxTransform (cMatrixf) —
  • abSetChildrenUpdated (bool) —

Returns:

  • void

SetParent

void SetParent(cNode3D@ apNode)


Parameters

Returns:

  • void

SetPosition

void SetPosition(const cVector3f &in avPos)


Parameters

Returns:

  • void

SetPostTransform

void SetPostTransform(const cMatrixf &in a_mtxTransform)


Parameters

Returns:

  • void

SetPostTransformReversed

void SetPostTransformReversed(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetPreTransform

void SetPreTransform(const cMatrixf &in a_mtxTransform)


Parameters

Returns:

  • void

SetUsePostTransform

void SetUsePostTransform(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetUsePreTransform

void SetUsePreTransform(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetVisible

int SetVisible(bool abX,
               bool abCascade)


Parameters

  • abX (bool) —
  • abCascade (bool) —

Returns:

  • int

SetWorldMatrix

void SetWorldMatrix(const cMatrixf &in a_mtxWorldTransform)


Parameters

Returns:

  • void

SetWorldPosition

void SetWorldPosition(const cVector3f &in avWorldPos)


Parameters

Returns:

  • void

UpdateEntityChildren

void UpdateEntityChildren()

Returns:

  • void

UpdateMatrix

void UpdateMatrix(bool abSetChildrenUpdated)


Parameters

  • abSetChildrenUpdated (bool) —

Returns:

  • void

References

See all references...