PopcornFX v2.8

Generic selectors
Exact matches only
Search in title
Search in content
  1. Home
  2. Docs
  3. PopcornFX v2.8
  4. Scripting reference
  5. Samplers
  6. Animtrack sampler

Animtrack sampler

Animtrack sampler

Transform functions

Return typeDescription
float3SamplerName.transform(float3 position, float cursor [, int trackIdx])
Transforms the input position by the track transforms at location cursor along the track. The optional trackIdx argument is a track index if the animtrack has multiple tracks.
float3SamplerName.translate(float3 position, float cursor [, int trackIdx])
Translates the input position by the track translations at location cursor along the track. The optional trackIdx argument is a track index if the animtrack has multiple tracks.
float3SamplerName.rotate(float3 vector, float cursor [, int trackIdx])
Rotates the input vector by the track rotations at location cursor along the track. The optional trackIdx argument is a track index if the animtrack has multiple tracks.
float3SamplerName.scale(float3 vector, float cursor [, int trackIdx])
Scales the input vector by the track scale at location cursor along the track. The optional trackIdx argument is a track index if the animtrack has multiple tracks.

 

Transform accessors

Return typeDescription
float3SamplerName.samplePosition(float cursor [, int trackIdx])
Samples the position at location cursor along the track. The optional trackIdx argument is a track index if the animtrack has multiple tracks.
float3SamplerName.sampleScale(float cursor [, int trackIdx])
Samples the scale at location cursor along the track. The optional trackIdx argument is a track index if the animtrack has multiple tracks.
orientationSamplerName.sampleOrientation(float cursor [, int trackIdx])
Samples the orientation at location cursor along the track. The optional trackIdx argument is a track index if the animtrack has multiple tracks.
float3SamplerName.axisSide(float cursor [, int trackIdx])
Returns the side axis at location cursor along the track. The optional trackIdx argument is a track index if the animtrack has multiple tracks.
float3SamplerName.axisVertical(float cursor [, int trackIdx])
Returns the vertical axis at location cursor along the track. The optional trackIdx argument is a track index if the animtrack has multiple tracks.
float3SamplerName.axisDepth(float cursor [, int trackIdx])
Returns the depth axis at location cursor along the track. The optional trackIdx argument is a track index if the animtrack has multiple tracks.
float3SamplerName.axisLeft(float cursor [, int trackIdx])
Returns the left axis at location cursor along the track. The optional trackIdx argument is a track index if the animtrack has multiple tracks.
float3SamplerName.axisRight(float cursor [, int trackIdx])
Returns the right axis at location cursor along the track. The optional trackIdx argument is a track index if the animtrack has multiple tracks.
float3SamplerName.axisDown(float cursor [, int trackIdx])
Returns the down axis at location cursor along the track. The optional trackIdx argument is a track index if the animtrack has multiple tracks.
float3SamplerName.axisUp(float cursor [, int trackIdx])
Returns the up axis at location cursor along the track. The optional trackIdx argument is a track index if the animtrack has multiple tracks.
float3SamplerName.axisBackward(float cursor [, int trackIdx])
Returns the backward axis at location cursor along the track. The optional trackIdx argument is a track index if the animtrack has multiple tracks.
float3SamplerName.axisForward(float cursor [, int trackIdx])
Returns the forward axis at location cursor along the track. The optional trackIdx argument is a track index if the animtrack has multiple tracks.

 

Disclaimer: These are describing the reference implementation. When using attribute samplers, the behavior of these functions can vary depending on the implementation in the game-engine where the effect is loaded.

Was this article helpful to you? Yes No

How can we help?