Class SkeletonPhysicsData

Data resource that holds the configuration for various skeleton-based dynamic animations.

Hierarchy (view full)

Constructors

constructor

Accessors

boneColliders handle inverseKinematics isDestroyed metaData name uuid

Methods

createBoneCollider createFootInverseKinematicsChain createInverseKinematicsChain duplicate onCreate onDeserializationEnded onDisable onEnable onInitialize onSerializationStart removeBoneCollider removeInverseKinematicsChain revert unload

Constructors

constructor

Accessors

boneColliders

handle

inverseKinematics

isDestroyed

  • get isDestroyed(): boolean

  • Determines if the resource is destroyed.

    Returns boolean

    Note

    This can happen when the Resource was forcefully unloaded or reverted. For this reason, it is safer to hold on to a instead of directly referencing a resource pointer, as the current Resource can always be retrieved via .value.

metaData

name

  • get name(): string

  • Name of the resource. Use primarily for easier identification and not important to the engine itself.

    Returns string

uuid

  • get uuid(): UUID

  • Returns a universally unique identifier of this resource.

    Returns UUID

Methods

createBoneCollider

  • createBoneCollider(skeleton, boneName): void

  • Creates a bone collider for the given bone

    Parameters

    • skeleton: Skeleton

      The skeleton the bone is in

    • boneName: string

    Returns void

createFootInverseKinematicsChain

  • createFootInverseKinematicsChain(skeleton, bones, boundsBottom): InverseKinematicsChainConfiguration

  • Creates an inverse kinematics chain for foot placement from the given bones.

    Parameters

    • skeleton: Skeleton

      The skeleton containing the bones

    • bones: Immutable<SkeletonBoneData>[]

      The bones to create an IK chain from

    • boundsBottom: number

      The bottom bounds of the mesh containing the skeleton. Used to determine heel height.

    Returns InverseKinematicsChainConfiguration

    the created chain configuration or null if unsuccessful

createInverseKinematicsChain

duplicate

  • duplicate(): Resource

  • Duplicates the resource and creates a unique UUID for the duplicated resource.

    Returns Resource

    The duplicated resource or null, if the duplication failed.

onCreate

  • onCreate(): void
  • Virtual

    Method called by RSX to perform actions required after the creation of the resource.

    Returns void

onDeserializationEnded

  • onDeserializationEnded(): void
  • Virtual

    Method called by RSX to perform any operations needed after deserialization.

    Returns void

    Note

    Use this API to restore your serializable data into live objects.

onDisable

  • onDisable(): void
  • Virtual

    Method called by RSX to disable the resource.

    Returns void

    Note

    Use this API to deactivate the resource before it is serialized.

onEnable

  • onEnable(): void
  • Virtual

    Method called by RSX to enable the resource.

    Returns void

    Note

    Use this API to activate the resource after it has been disabled by serialization.

onInitialize

  • onInitialize(): void
  • Virtual

    Method called by RSX to perform initialization of the resource.

    Returns void

    Note

    Use this API to initialize data and default construct all fields.

onSerializationStart

  • onSerializationStart(): void
  • Virtual

    Method called by RSX to perform any operations before serialization.

    Returns void

    Note

    Use this API to bake your live data into serializable data.

removeBoneCollider

  • removeBoneCollider(boneName): void

  • Removes the bone collider for the bone with the given name.

    Parameters

    • boneName: string

      The name of the bone to remove the collider for

    Returns void

removeInverseKinematicsChain

  • removeInverseKinematicsChain(chainToRemove): void

  • Removes the given inverse kinematics chain

    Parameters

    Returns void

revert

  • revert(): boolean

  • Reverts the resource to the on-disk representation.

    Returns boolean

    Note

    This is a potentially expensive call, as it needs to deserialize and replace all existing in-memory resource handles.

unload

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods