CAE Animation

xCAEAnimationStart

Starts CAE animation and applies animation settings.

bool xCAEAnimationStart()

return

Returns True, if successful.

This method is discontinued from VCollabPro 2017R1.

To add CAE animation in Viewpoint, it is recommended to use `xSetCAEAnimationInCurViewPoint <./ViewPoint%20Operations.md#xsetcaeanimationincurviewpoint>`__ method.

xCAEAnimationStop

Stops CAE Animation.

bool xCAEAnimationStop()

return

Returns True, if successful.

xSetCAEAnimationSettings

Sets CAE animation settings like Animation type, number of frames, etc.

bool xSetCAEAnimationSettings(String sModel, short iAnimationType, long iNoOfFrames, bool bHarmonic, bool bSwing, bool bStaticFringe, String sSelectedFrames, bool bInterpolate, bool bStaticColorPlot)

return

Returns True, if successful.

sModel

CAE Model Name. Set empty String to set it to the current CAE model.

iAnimationType

Sets Animation Type. Valid Range 0-3.

0 - LINEAR
1 - TRANSIENT
2 - RESULTS
3 - EIGEN_VECTOR

iNoOfFrames

Sets number of frames.

bHarmonic

Sets Harmonic animation flag.

bSwing

Sets swing flag.

bStaticFringe

Sets Static fringe flag.

sSelectedFrames

Sets selected frames. Each entry of the select frame has to be separated by semicolan ;.

Example, to select Instances in transient animation “L1M1;L1M2;L1M3”.

In Eigen Animations, it is a result name “Displacement”.

Note: To use the default selected frame(s) just pass an empty String.

bInterpolate

Sets Interpolation in transient animation.

bStaticColorPlot.

Set Static colorplot.

xSetCAEAnimationFrame

Sets the current frame using the passed number.

bool xSetCAEAnimationFrame(String sModel, long iFrameNo)

return

Returns True, if successful.

sModel

CAE Model name.

iFrameNo

Frame number. Valid range: 0 to within the range of CAE animation settings.

xSetCAEAnimationSkipByFrames

Sets CAE animation to skip the specific number of frame intervals.

bool xSetCAEAnimationSkipByFrames(String sModel, long iSkipByFrames, short iHDD)

return

Returns True, if successful.

sModel

CAE Model name.

iSkipByFrames

Set skip frame value. Example: if set as 2, it plays the first frame then skips second and third frames and plays fourth frame.

iHDD

Specifies Frame data from RAM or HDD.

Set 1 as default. Loads data from hard disk.

• Copies all data to RAM. In future reference, it plays from RAM. So the speed is based on RAM size.

• Loads every frame data from Hard disk itself.

Valid Range 0 and 1.

xSetCAEAnimationSyncronize

Syncronizes CAE animations of a different model.

bool xSetCAEAnimationSyncronize(bool bSyncronize)

return

Returns True, if successful.

bSyncronize

Set true to sync animations of multiple CAE models.

xSetCAEAnimationSpeed

Controls CAE animation speed.

bool xSetCAEAnimationSpeed(String sModel, short iSlowness)

return

Returns True, if successful.

sModel

CAE Model name.

iSlowness

Set a delay value to slow animation in milliseconds.

Valid range 0 to 1000. 0 sets max speed.

xGetCAEAnimationNoOfFrames

Gets the number of frames applied for CAE animation.

int xGetCAEAnimationNoOfFrames(String sModel)

return

Returns number of frames set.

sModel

CAE Model name. For future use. Currently ignored and uses current CAE model by default. Empty String (“”) can be passed.

xGetCAEAnimationType

Gets current CAE animation type.

int xGetCAEAnimationType(String sModel)

return

Returns current CAE animation type.

0 - CAE_ANIMATION_LINEAR
1 - CAE_ANIMATION_TRANSIENT
2 - CAE_ANIMATION_RESULTS
4 - CAE_ANIMATION_EIGEN_VECTOR
5 - CAE_ANIMATION_DATA_SET

sModel

CAE Model name. For future use. Currently ignored and uses current CAE model by default. Empty String (“”) can be passed.

pxGetCAEAnimationSelectedFrames

Gets selected frames for current CAE animation type.

List<String> pxGetCAEAnimationSelectedFrames(String sModel)

return

Returns selected frame names for current animation type in an array of Strings.

sModel

CAE Model name. For future use. Currently ignored and uses current CAE model by default. Empty String (“”) can be passed.

pxGetCAEAnimationSettings

List<int> pxGetCAEAnimationSettings(String sModel)

return

Returns current CAE Animation Type and attributes as the following order. Array size is 6.

retArray[0] = iAnimationType
retArray[1] = iNoOfFrames
retArray[2] = bHarmonic
retArray[3] = bStaticFringe
retArray[4] = bSwing
retArray[5] = bTrace

sModel

CAE Model name. For future use. Currently ignored and uses current CAE model by default. Empty String (“”) can be passed.

xSetCAETransientAnimationInterpolate

Sets interpolation flag if current animation is set as transient animation.

bool xSetCAETransientAnimationInterpolate(bool bInterpolate, int iNoOfKeyFrames, String sModel=””, String sKey=””)

return

Returns always True now. For future use.

sModel

CAE Model name. For future use. Currently ignored and uses current CAE model by default. Empty String (“”) can be passed.

sKey

For future use. Currently ignored and Time by default. Empty String (“”) can be passed.

xIsCAETransientAnimationInterpolated

Gets CAE Transient animation Interpolation mode.

bool xIsCAETransientAnimationInterpolated(String sModel=””)

return

Returns True, if Interpolation is applied in CAE transient animation.

sModel

CAE Model name. For future use. Currently ignored and uses current CAE model by default. Empty String (“”) can be passed.

xGetCAETransientAnimationInterpolateFramesCount

Gets Number of frames set in CAE Transient Animation when interpolation is applied.

int xGetCAETransientAnimationInterpolateFramesCount(String sModel=””)

return

Returns number of keyframes for Transient interpolation.

sModel

CAE Model name. For future use. Currently ignored and uses current CAE model by default. Empty String (“”) can be passed.

xIsOnCAEAnimation

Checks CAE animation active state.

bool xIsOnCAEAnimation()

return

Returns True, if Animation is active.

xSetPivotData

Set pivot point or element (triangle) with given input data.

bool xSetPivotData(String sModel, int iNodeID, int iElementID, int iPivotType, String sPartName)

return

Returns True if successfully set the pivot information. False otherwise.

sModel

CAE model name

iNodeID

Node ID associated with pivot.

iElementID

Element ID associated with pivot.

If iElement is a valid element id in the given part, then pivot type will forced to be plane type. iPivotType is ignored.

iPivotType

Pivot type

0 - None
1 - Point pivot
2 - Plane pivot

sPartName

Part name associated with the pivot.

xSetCAEAnimationLegendRangeOptions

Sets Legend animation options.

bool xSetCAEAnimationLegendRangeOptions(String sModel, bool bUseLegendColorSize, bool bSingleBand, int iTrailMode, bool bReverseFlow)

return

Returns True, if successful.

sModel

Model name.

bUseLegendColorSize

If True, number of frames is set as size of legend colors.

bSingleBand

If True, one band color will be displayed on animation.

iTrailMode

Sets trailing color mode.

0 - ColorPlot Transparent
1 - NoResult Opaque
2 - No result Transparent

bReverseFlow

Set true to reverse trail color mode flow direction.

pxGetCAEAnimationLegendRangeOptions

Gets options set in Legend animation.

List<int> pxGetCAEAnimationLegendRangeOptions(String sModel)

return

Returns and array of size 4.

rtnArrray[0] = bUseLegendColorSize
rtnArrray[1] = bSingleBand
rtnArrray[2] = iTrailMode
rtnArrray[3] = bReverseFlow

sModel

Model name.