Interface MeshInstance

interface which is the container for meshes and materials and provide interface for animation controlling. Subinterface of component

Hierarchy

Component
- MeshInstance

Methods

animationChange

animationChange(animation, mode): void
Change current animation if animation with specified name exist.
Parameters
- animation: string
- mode: AnimationMode
  
  mode
Returns void

animationPause

animationPause(): void
pause animation playback.

Returns void

animationPlay

animationPlay(): void
Start animation playback.

Returns void

animationSeek

animationSeek(positionNs): void
Set current animation playback position.
Parameters
- positionNs: number
  
  position in ns.
Returns void

asFaceMorphing

asFaceMorphing(): FaceMorphing
cast component to faceMorphing subinterface instance. Will throw if derived interface is not instance of faceMorphing.

Returns FaceMorphing

Inherited from Component.asFaceMorphing

asFaceTracker

asFaceTracker(): FaceTracker
cast component to face tracker subinterface instance. Will throw if derived interface is not instance of faceTracker.

Returns FaceTracker

Inherited from Component.asFaceTracker

asMeshInstance

asMeshInstance(): MeshInstance
cast component to meshInstance subinterface instance. Will throw if derived interface is not instance of meshInstance.

Returns MeshInstance

Inherited from Component.asMeshInstance

asTransformation

asTransformation(): Transformation3d
cast component to transformation3d subinterface instance. Will throw if derived interface is not instance of transformation3d.

Returns Transformation3d

Inherited from Component.asTransformation

getAnimation

getAnimation(): string
Returns string
current set animation name (string).

getAnimationDurationNs

getAnimationDurationNs(): number
Returns number
current animation playback duration (long).

getAnimationMode

getAnimationMode(): AnimationMode
Returns AnimationMode
current set animation mode (animationMode). Can be off loop once onceReversed fixed.

getAnimationPositionNs

getAnimationPositionNs(): number
Returns number
current animation playback position (long).

getAnimationTimeOffset_ns

getAnimationTimeOffset_ns(): number
Returns current animation playback time offset from begin(0). Typycally equals animation position mod animation duration.

Returns number
animation playback time offset (long).

getComponentType

getComponentType(): ComponentType
Returns ComponentType
component type. Can be faceTracker, transformation, meshInstance or faceMorphing.

Inherited from Component.getComponentType

getMaterials

getMaterials(): Vector<Material>
get materials for each sub geometry

Returns Vector<Material>
materials

getMesh

getMesh(): Mesh
Returns Mesh
mesh (mesh).

getPhysicsSimulator

getPhysicsSimulator(): PhysicsSimulator
Returns PhysicsSimulator
physicsSimulator of current meshInstance

getSubGeometryMaterial

getSubGeometryMaterial(subGeometryName): Material
returns material from mesh sub geometry with specified name if it exist, null otherwise
Parameters
- subGeometryName: string
  
  sub geometry name.
Returns Material
sub geometry material (material).

isAnimationEnded

isAnimationEnded(): boolean
True if animation playback stop.

Returns boolean
animation playback active flag (boolean).

isAnimationPlaying

isAnimationPlaying(): boolean
True if animation playback was started.

Returns boolean
animation playback active flag (boolean).

isVisible

isVisible(): boolean
Returns boolean
visibility flag

setAnimationTimeOffset_ns

setAnimationTimeOffset_ns(timeNs): void
Set current animation playback time offset from begin(0). duration.
Parameters
- timeNs: number
  
  animation playback time offset.
Returns void

setMesh

setMesh(mesh): void
set mesh for given mesh instance. Of some mesh was settled before need to re set all materials.
Parameters
- mesh: Mesh
  
  new mesh.
Returns void

setSubGeometryMaterial

setSubGeometryMaterial(subGeometryName, material): void
set for mesh sub geometry with specified name specified material if sub geometry with given name exists.
Parameters
- subGeometryName: string
  
  sub geometry name.
- material: Material
  
  sub geometry material.
Returns void

setVisible

setVisible(visible): void
set mesh visibility flag. Will be overridden if entity with meshInstance component is child of entity with faceTracker component.
Parameters
- visible: boolean
Returns void