Transform functions
Return type | Description |
float3 | SamplerName.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. |
float3 | SamplerName.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. |
float3 | SamplerName.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. |
float3 | SamplerName.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 type | Description |
float3 | SamplerName.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. |
float3 | SamplerName.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. |
orientation | SamplerName.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. |
float3 | SamplerName.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. |
float3 | SamplerName.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. |
float3 | SamplerName.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. |
float3 | SamplerName.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. |
float3 | SamplerName.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. |
float3 | SamplerName.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. |
float3 | SamplerName.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. |
float3 | SamplerName.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. |
float3 | SamplerName.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.