Class MeshShapeSampler

Hierarchy

ShapeSampler
- MeshShapeSampler

Index

Enumerations

Channel
Type

Constructors

constructor

Constructors

constructor

new MeshShapeSampler(): MeshShapeSampler
new MeshShapeSampler(mesh: string): MeshShapeSampler
new MeshShapeSampler(mesh: string, animation: string): MeshShapeSampler

Overrides ShapeSampler.constructor
- Defined in lumin/utils/ParticleSamplers.d.ts:493
Default constructor

Returns MeshShapeSampler
Overrides ShapeSampler.constructor
- Defined in lumin/utils/ParticleSamplers.d.ts:496
Constructor

Parameters
- mesh: string
  
  Mesh file (*.pkmm) to use for the sampler.
Returns MeshShapeSampler
Overrides ShapeSampler.constructor
- Defined in lumin/utils/ParticleSamplers.d.ts:503
Constructor

Parameters
- mesh: string
  
  Mesh file (*.pkmm) to use for the sampler.
- animation: string
  
  Animation file (*.pksa) to use for the sampler.
Returns MeshShapeSampler

Methods

getAngularVelocity

getAngularVelocity(): [number, number, number]

Inherited from ShapeSampler.getAngularVelocity
- Defined in lumin/utils/ParticleSamplers.d.ts:101
Returns the angular velocity of the mesh.

priv

none

Returns [number, number, number]

velocity

getAnimLoopCount

getAnimLoopCount(): number

- Defined in lumin/utils/ParticleSamplers.d.ts:640
Returns the animation loop count.

priv

none

Returns number

loop count

getAnimTimeBegin

getAnimTimeBegin(): number

- Defined in lumin/utils/ParticleSamplers.d.ts:613
Returns the animation loop start time.

priv

none

Returns number

begin time

getAnimTimeEnd

getAnimTimeEnd(): number

- Defined in lumin/utils/ParticleSamplers.d.ts:622
Returns the animation loop end time.

priv

none

Returns number

end time

getAnimTimeStart

getAnimTimeStart(): number

- Defined in lumin/utils/ParticleSamplers.d.ts:631
Returns the initial start time of the animation.

priv

none

Returns number

start time

getAnimation

getAnimation(): string

- Defined in lumin/utils/ParticleSamplers.d.ts:538
Returns the animation file name.

priv

none

Returns string

animation file name

getChannels

getChannels(): number

- Defined in lumin/utils/ParticleSamplers.d.ts:556
Returns the channels values being used for the mesh. Values are the Channel enum or'ed together.

priv

none

Returns number

channels

getLinearVelocity

getLinearVelocity(): [number, number, number]

Inherited from ShapeSampler.getLinearVelocity
- Defined in lumin/utils/ParticleSamplers.d.ts:119
Returns the linear velocity of the mesh.

priv

none

Returns [number, number, number]

velocity

getMesh

getMesh(): string

- Defined in lumin/utils/ParticleSamplers.d.ts:520
Returns the mesh file name.

priv

none

Returns string

mesh file name

getScale

getScale(): number

- Defined in lumin/utils/ParticleSamplers.d.ts:595
Returns the scale for the shape.

priv

none

Returns number

Scale

getSubMeshIndex

getSubMeshIndex(): number

- Defined in lumin/utils/ParticleSamplers.d.ts:575
Returns the sub-mesh index to use.

priv

none

Returns number

Sub-mesh index

getType

getType(): Type

Inherited from ShapeSampler.getType
- Defined in lumin/utils/ParticleSamplers.d.ts:92
Return the shape sampler type.

priv

none

Returns Type

the type

setAngularVelocity

setAngularVelocity(velocity: [number, number, number] | Float32Array): void

Inherited from ShapeSampler.setAngularVelocity
- Defined in lumin/utils/ParticleSamplers.d.ts:110
Sets the angular velocity to apply to the mesh.

priv

none

Parameters
- velocity: [number, number, number] | Float32Array
  
  Velocity
Returns void

setAnimation

setAnimation(animation: string): void

- Defined in lumin/utils/ParticleSamplers.d.ts:547
Sets the animation file (*.pksa) to use for the sampler.

priv

none

Parameters
- animation: string
  
  Animation file name
Returns void

setAnimationTiming

setAnimationTiming(beginTime: number, endTime: number, startTime: number, loopCount: number): void

- Defined in lumin/utils/ParticleSamplers.d.ts:654
Sets custom params for controlling the timing of the animation. By default, the animation will play starting at time 0, go to the natural end of the animation, and loop forever.

priv

none

Parameters
- beginTime: number
  
  The beginning of the animation loop.
- endTime: number
  
  The end of the animation loop. Must be >= beginTime. <0 will go to the natural end of the animation.
- startTime: number
  
  Where the animation will start when first played. Must be >= beginTime and <= endTime.
- loopCount: number
  
  How many times the animation will loop. If < 0, will loop infinitely.
Returns void

setChannels

setChannels(channels: number): void

- Defined in lumin/utils/ParticleSamplers.d.ts:566
Sets which channels will be used for the mesh. Generally doesn't need to be called, as the channels will be set up correctly for the sampler.

priv

none

Parameters
- channels: number
  
  Channel values or'ed together
Returns void

setLinearVelocity

setLinearVelocity(velocity: [number, number, number] | Float32Array): void

Inherited from ShapeSampler.setLinearVelocity
- Defined in lumin/utils/ParticleSamplers.d.ts:128
Sets the linear velocity to apply to the mesh.

priv

none

Parameters
- velocity: [number, number, number] | Float32Array
  
  Velocity
Returns void

setMesh

setMesh(mesh: string): void

- Defined in lumin/utils/ParticleSamplers.d.ts:529
Sets the mesh file (*.pkmm) to use for the sampler.

priv

none

Parameters
- mesh: string
  
  Mesh file name
Returns void

setScale

setScale(scale: number): void

- Defined in lumin/utils/ParticleSamplers.d.ts:604
Sets the shape scale. The scale will be applied evenly to all axes.

priv

none

Parameters
- scale: number
  
  Scale
Returns void

setSubMeshIndex

setSubMeshIndex(index: number): void

- Defined in lumin/utils/ParticleSamplers.d.ts:586
Sets the sub-mesh index to use, if the mesh has multiple sub-meshes. If the mesh contains both static and skinned sub-meshes, the index will start with the static meshes, and then go to the skinned meshes.

priv

none

Parameters
- index: number
  
  Sub-mesh index.
Returns void

Generated using TypeDoc