pxlAnim

Methods

(static) Animation#addClips(animName, clipName, animFbx)

Description:

• Add a clip to an object Use pxlFile.loadAnimFBX() to load your animation clips

Source:

• pxlNav/core/Animation.js, line 146

Example

// Add a clip to an object
pxlAnim.addClips( "myAnim", "myClip", fbxLoader_animationCycleRoot );

Parameters:

(static) Animation#destroy(animName)

Description:

• Destroy a rig + animation objects of the provided animation name

Source:

• pxlNav/core/Animation.js, line 386

Example

// Destroy a rig + animation objects of the provided animation name
this.pxlAnim.destroy( "myAnim" );

Parameters:

(static) Animation#getMesh(animName) → {Object}

Description:

• Get mesh of the rigged object

Source:

• pxlNav/core/Animation.js, line 233

Example

// Get mesh of the rigged object
let mesh = this.pxlAnim.getMesh( this.animRigName );
console.log( mesh );

Parameters:

Returns:

Type

Object

(static) Animation#getMixer(animName) → {string}

Description:

• Get the current state of an object

Source:

• pxlNav/core/Animation.js, line 197

Example

// Get the current state of an object
let curState = this.pxlAnim.getMixer( this.animRigName );
console.log( curState );

Parameters:

Returns:

Type

string

(static) Animation#getRig(animName) → {Object}

Description:

• Get animation rig of an object

Source:

• pxlNav/core/Animation.js, line 215

Example

// Get animation rig of an object
let rig = this.pxlAnim.getRig( this.animRigName );
console.log( rig );

Parameters:

Returns:

Type

Object

(static) Animation#hasClip(animName, clipName) → {boolean}

Description:

• Check if an object has a clip

Source:

• pxlNav/core/Animation.js, line 178

Example

// Check if an object has a clip
let hasClip = this.pxlAnim.hasClip( this.animRigName, "myClipName" );
console.log( hasClip );

Parameters:

Returns:

Type

boolean

(static) Animation#initObject(animName, animFbx)

Description:

• Initialize an object for animation

Source:

• pxlNav/core/Animation.js, line 58

Parameters:

(static) Animation#playClip(animName, clipName)

Description:

• Play a clip on an object

Source:

• pxlNav/core/Animation.js, line 250

Example

// Play a clip on an object
this.pxlAnim.playClip( this.animRigName, "myClipName" );

Parameters:

(static) Animation#setStateConnections(animName, clipName, speed)

Description:

• Set animation cycle speed in the mixer

  This is handled when the FBX is loaded, this is visible for the example

Source:

• pxlNav/core/Animation.js, line 332

Example

// Set animation cycle speed in the mixer
constructor(){
    this.animSource = {
      "RabbitDruidA" : {
        "rig" : this.assetPath+"RabbitDruidA/RabbitDruidA_rig.fbx",
        "anim" : {
          "Sit_Idle" : this.assetPath+"RabbitDruidA/RabbidDruidA_anim_sit_idle.fbx",
          "Sit_Stoke" : this.assetPath+"RabbitDruidA/RabbidDruidA_anim_sit_stoke.fbx",
          "Sit_Look" : this.assetPath+"RabbitDruidA/RabbidDruidA_anim_sit_look.fbx"
        },
        "stateConnections"  : {
          // Non existing states will be ignored and loop'ed, ie "Walk"
          "Sit_Idle" : [ ...Array(6).fill("Sit_Idle"), ...Array(6).fill("Sit_Stoke"), ...Array(5).fill("Sit_Look")],
          "Sit_Stoke" : ["Sit_Idle"],
          "Sit_Look" : ["Sit_Idle"]
        }
      }
    };
  }

Parameters:

(static) Animation#setWeight(animName, clipName, weight, disableOthers)

Description:

• Set blend weights of animation cycle in the mixer

Source:

• pxlNav/core/Animation.js, line 280

Example

// Set blend weights of animation cycle in the mixer
//this.pxlAnim.setWeight( this.animRigName, "myClipName", 1, true );
this.pxlAnim.setWeight( this.animRigName, "myClipName", 0.5, false );
//this.pxlAnim.setWeight( this.animRigName, "myClipName", 0.25, true );

Parameters: