Interface Skin

Represents skinning data for rigged meshes. See also: MeshVisual.

interface Skin {
    enabled: boolean;
    sceneObject: SceneObject;
    uniqueIdentifier: string;
    clearBones(): void;
    destroy(): void;
    getSceneObject(): SceneObject;
    getSkinBone(boneName: string): SceneObject;
    getSkinBoneNames(): string[];
    getTransform(): Transform;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    setSkinBone(boneName: string, bone: SceneObject): void;
}

Hierarchy (view full)

Properties

enabled sceneObject uniqueIdentifier

Methods

clearBones destroy getSceneObject getSkinBone getSkinBoneNames getTransform getTypeName isOfType isSame setSkinBone

Properties

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

ReadonlysceneObject

sceneObject: SceneObject

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

clearBones

  • clearBones(): void

  • Remove all bones on the skin.

    Returns void

destroy

  • destroy(): void

  • Destroys the component.

    Returns void

getSceneObject

getSkinBone

getSkinBoneNames

  • getSkinBoneNames(): string[]

  • Get all the bone names on the skin.

    Returns string[]

getTransform

getTypeName

  • getTypeName(): string

  • Returns the name of this object's type.

    Returns string

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

setSkinBone

  • setSkinBone(boneName, bone): void

  • Parameters

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods