AnimationParameters

AnimationParameters Struct

The AnimationParameters struct contains settings for playing animations.

Syntax

[Sansar.Script.Interface]
public struct AnimationParameters

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

Members

See Also: Inherited members from ValueType.

Public Fields

 
BlendDuration float . Time in seconds taken to blend to this animation.
 
ClampToRange bool . If true, clamp the animation frames to the range specified by rangeStartFrame and rangeLength. If false, play the whole animation.
 
PlaybackMode AnimationPlaybackMode . Animation playback mode.
 
PlaybackSpeed float . Animation playback speed. Negative values will play the animation backwards.
 
RangeEndFrame int . End frame to use when clamping animation range. This should always be greater or equal to the range start frame.
 
RangeStartFrame int . Start frame to use when clamping animation range.

Member Details

BlendDuration Field

Time in seconds taken to blend to this animation.

Syntax

[Sansar.Script.Interface]
public float BlendDuration

Remarks

The default value is 0.

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

ClampToRange Field

If true, clamp the animation frames to the range specified by rangeStartFrame and rangeLength. If false, play the whole animation.

Syntax

[Sansar.Script.Interface]
public bool ClampToRange

Remarks

The default is false.

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

PlaybackMode Field

Animation playback mode.

Syntax

[Sansar.Script.Interface]
public AnimationPlaybackMode PlaybackMode

Remarks

Default is Looping.

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

PlaybackSpeed Field

Animation playback speed. Negative values will play the animation backwards.

Syntax

[Sansar.Script.Interface]
public float PlaybackSpeed

Remarks

The default is 1.0.

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

RangeEndFrame Field

End frame to use when clamping animation range. This should always be greater or equal to the range start frame.

Syntax

[Sansar.Script.Interface]
public int RangeEndFrame

Remarks

The default value is 0.

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

RangeStartFrame Field

Start frame to use when clamping animation range.

Syntax

[Sansar.Script.Interface]
public int RangeStartFrame

Remarks

The default value is 0.

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Article is closed for comments.