Module vrAnimWidgets

[frames] | no frames]

Module vrAnimWidgets

Functions

playAnim(name)
Evaluates an animation block or animation clip via name.

playAnim(name, startFrame, endFrame)
Plays an animation block or animation clip from start to end via name.

playCAnimation(name)
Plays an animation block or animation clip via name.

playCAnimation(name, startFrame, endFrame)
Plays an animation block or animation clip from start to end via name.

bool

addChoiceControlPoint(node, time, value)
Adds control points to choice channel of node.

bool

addChoiceControlPoints(node, times, values)
Adds multiple control points to choice channel of node.

bool

addRotationControlPoint(node, time, rot)
Adds control points to rotation channel of node.

bool

addRotationControlPoints(node, times, rots)
Adds multiple control points to rotation channel of node.

bool

addRotationOrientationControlPoint(node, time, rot)
Adds control points to rotation orientation channel of node.

bool

addRotationOrientationControlPoints(node, times, rots)
Adds multiple control points to rotation orientation channel of node.

bool

addScaleControlPoint(node, time, scale)
Adds control points to scale channel of node.

bool

addScaleControlPoints(node, times, scales)
Adds multiple control points to scale channel of node.

bool

addToAnimClip(clip, object, frame)
Adds a block, clip or camera track to an animation clip.

bool

addTranslationControlPoint(node, time, trans, updateGui)
Adds control points to translation channel of node.

bool

addTranslationControlPoints(node, times, trans, updateGui)
Adds multiple control points to translation channel of node.

bool

addVisibleControlPoint(node, time, value)
Adds control points to visible channel of node.

bool

addVisibleControlPoints(node, times, values)
Adds multiple control points to visible channel of node.

animateClippingTransform()
Loads the clipping transform node into curve editor.

vrNodePtr

createAnimClip(name, parentClip)
Creates a new animation clip.

bool

createAnimationBlockForMaterial(node, updateGui)
Creates an animation block for passed material (if possible).

bool

createAnimationBlockForNode(node, updateGui)
Creates an animation block for passed node (if possible).

vrNodePtr

findAnimBlock(name)
Finds an animation block by name.

vrNodePtr

findAnimClip(name)
Finds an animation clip by name.

vrNodePtr

findCameraTrackBlock(camera)
Finds an camera track block by name.

std::vector<vrNodePtr>

getAnimBlockNodes(includeHidden)
Gets all animation block nodes from scene.

std::vector<std::string>

getAnimBlocks(includeHidden)
Gets all animation block names from scene.

std::vector<vrNodePtr>

getAnimClipNodes()
Gets all top-level animation clip nodes from scene.

std::vector<std::string>

getAnimClips()
Gets all top-level animation clip names from scene.

Real64

getCurrentFrame()
Gets the current frame of the time line.

bool

isPlaying()
Returns if object with given name is playing.

keyAll()
Sets a keyframe for all attributes.

keySelected()
Sets a keyframe for selected attributes.

pauseCAnimation()

resetAnim(name)
Resets the animation block or clip via name.

resetCAnimation(name)
Resets the animation block or clip via name.

bool

restoreAnimation(node)
Deprecated: Use vrUndoService.undo() in API v2.

bool

restoreAnimations(nodes)
Deprecated: Use vrUndoService.undo() in API v2.

setAnimClipActive(clip, active)
Activates/Deactivates an animation clip.

setAnimClipDuration(clip, frames)
Sets the frame duration of an animation clip.

setAnimClipEnd(clip, frame, keepStart)
Sets the end frame of an animation clip.

setAnimClipFlipped(clip, flipped)
Flippes/Unflippes an animation clip.

setAnimClipLocked(clip, locked)
Locked/Unlockes an animation clip.

setAnimClipStart(clip, frame, keepEnd)
Sets the start frame of an animation clip.

setCurrentFrame(frame)
Sets the current frame of the time line.

stopAnim(name)
Stops the animation evaluation of an animation block or animation clip via name.

bool

trashAnimation(node)
Moves animation to trash.

bool

trashAnimations(nodes)
Moves a list of animation to trash.

Function Details

playAnim(name)

Evaluates an animation block or animation clip via name. The function waits till animation is finished.

Parameters:

name (string) - name of the animation object

playAnim(name, startFrame, endFrame)

Plays an animation block or animation clip from start to end via name. The function waits till animation is finished.

Parameters:

name (string) - name of the animation object
startFrame (float) - the optional start of the play range
endFrame (float) - the optional end of the pay range

playCAnimation(name)

Plays an animation block or animation clip via name. This function returns immediatly.

Parameters:

name (string") - name of the animation object

playCAnimation(name, startFrame, endFrame)

Plays an animation block or animation clip from start to end via name. This function returns immediatly.

Parameters:

name (string) - name of the animation object
startFrame (float) - the optional start of the play range
endFrame (float) - the optional end of the pay range

addChoiceControlPoint(node, time, value)

Adds control points to choice channel of node.

Parameters:

node (NodePtr) - Node
time (Real32) - Time value for control points
value (Int32) - Choice value

Returns: bool

True if added, false otherwise

addChoiceControlPoints(node, times, values)

Adds multiple control points to choice channel of node.

Parameters:

node (NodePtr) - Node
times (std::vector<Real32>) - Time values for control points
values (std::vector<Int32>) - Choice values

Returns: bool

True if added, false otherwise

addRotationControlPoint(node, time, rot)

Adds control points to rotation channel of node.

Parameters:

node (NodePtr) - Node
time (Real32) - Time value for control points
rot (Vec3f) - Rotation value

Returns: bool

True if added, false otherwise

addRotationControlPoints(node, times, rots)

Adds multiple control points to rotation channel of node.

Parameters:

node (NodePtr) - Node
times (std::vector<Real32>) - Time values for control points
rots (std::vector<Vec3f>) - Rotation values

Returns: bool

True if added, false otherwise

addRotationOrientationControlPoint(node, time, rot)

Adds control points to rotation orientation channel of node.

Parameters:

node (NodePtr) - Node
time (Real32) - Time value for control points
rot (Vec3f) - Rotation value

Returns: bool

True if added, false otherwise

addRotationOrientationControlPoints(node, times, rots)

Adds multiple control points to rotation orientation channel of node.

Parameters:

node (NodePtr) - Node
times (std::vector<Real32>) - Time values for control points
rots (std::vector<Vec3f>) - Rotation values

Returns: bool

True if added, false otherwise

addScaleControlPoint(node, time, scale)

Adds control points to scale channel of node.

Parameters:

node (NodePtr) - Node
time (Real32) - Time value for control points
scale (Vec3f) - Scale value

Returns: bool

True if added, false otherwise

addScaleControlPoints(node, times, scales)

Adds multiple control points to scale channel of node.

Parameters:

node (NodePtr) - Node
times (std::vector<Real32>) - Time values for control points
scales (std::vector<Vec3f>) - Scale values

Returns: bool

True if added, false otherwise

addToAnimClip(clip, object, frame)

Adds a block, clip or camera track to an animation clip.

Parameters:

clip (vrNodePtr) - The target clip.
object (vrNodePtr) - The object which should be added to the clip.
frame (int) - The start frame for the block or camera track. This value has no effect for clips.

Returns: bool

True if successful, False otherwise.

addTranslationControlPoint(node, time, trans, updateGui)

Adds control points to translation channel of node.

Parameters:

node (NodePtr) - Node
time (Real32) - Time value for control points
trans (Vec3f) - Translation value
updateGui (bool) - GUI update

Returns: bool

True if added, false otherwise

addTranslationControlPoints(node, times, trans, updateGui)

Adds multiple control points to translation channel of node.

Parameters:

node (NodePtr) - Node
times (std::vector<Real32>) - Time values for control points
trans (std::vector<Vec3f>) - Translation values
updateGui (bool) - GUI update

Returns: bool

True if added, false otherwise

addVisibleControlPoint(node, time, value)

Adds control points to visible channel of node.

Parameters:

node (NodePtr) - Node
time (Real32) - Time value for control points
value (Real32) - Visible value

Returns: bool

True if added, false otherwise

addVisibleControlPoints(node, times, values)

Adds multiple control points to visible channel of node.

Parameters:

node (NodePtr) - Node
times (std::vector<Real32>) - Time values for control points
values (std::vector<Real32>) - Visible values

Returns: bool

True if added, false otherwise

createAnimClip(name, parentClip)

Creates a new animation clip.

Parameters:

name (string) - The name of the new clip.
parentClip (vrNodePtr) - The parent clip. For top-level clips a default instance of vrNodePtr should be used.

Returns: vrNodePtr

The created animation clip node.

createAnimationBlockForMaterial(node, updateGui)

Creates an animation block for passed material (if possible).

Parameters:

node (MaterialPtr) - Material
updateGui (Bool) - Trigger gui update

Returns: bool

True if created, false otherwise

createAnimationBlockForNode(node, updateGui)

Creates an animation block for passed node (if possible).

Parameters:

node (NodePtr) - Node
updateGui (Bool) - Trigger gui update

Returns: bool

True if created, false otherwise

findAnimBlock(name)

Finds an animation block by name.

Parameters:

name (string) - The name of the block to find.

Returns: vrNodePtr

The found block node or a default instance of vrNodePtr if no block was found.

findAnimClip(name)

Finds an animation clip by name.

Parameters:

name (string) - The name of the clip to find.

Returns: vrNodePtr

The found clip node or a default instance of vrNodePtr if no clip was found.

findCameraTrackBlock(camera)

Finds an camera track block by name.

Parameters:

camera, track, name (string) - The name of the camera track to find the block for.

Returns: vrNodePtr

The found camera track block node or a default instance of vrNodePtr if no camera track block was found.

getAnimBlockNodes(includeHidden)

Gets all animation block nodes from scene.

Parameters:

includeHidden (Bool) - Include hidden blocks

Returns: std::vector<vrNodePtr>

Animation Blocks

getAnimBlocks(includeHidden)

Gets all animation block names from scene.

Parameters:

includeHidden (Bool) - Include hidden blocks

Returns: std::vector<std::string>

Animation Blocks

getAnimClipNodes()

Gets all top-level animation clip nodes from scene.

Returns: std::vector<vrNodePtr>: Animation Clips

getAnimClips()

Gets all top-level animation clip names from scene.

Returns: std::vector<std::string>: Animation Clips

getCurrentFrame()

Gets the current frame of the time line.

Returns: Real64: Current frame

isPlaying()

Returns if object with given name is playing.

Returns: bool: True if playing, false otherwise

resetAnim(name)

Resets the animation block or clip via name.

Parameters:

name (string) - name of the animation object

resetCAnimation(name)

Resets the animation block or clip via name.

Parameters:

name (string) - name of the animation object

restoreAnimation(node)

Deprecated: Use vrUndoService.undo() in API v2.

Restores animation from trash.

Parameters:

node (NodePtr) - Node of animation object

Returns: bool

True if restored, false otherwise

restoreAnimations(nodes)

Deprecated: Use vrUndoService.undo() in API v2.

Restores a list of animation from trash.

Parameters:

nodes (std::vector<AnimNodePtr>) - Nodes of animation objects

Returns: bool

True if restored, false otherwise

setAnimClipActive(clip, active)

Activates/Deactivates an animation clip.

Parameters:

clip (vrNodePtr) - The target clip.
active (bool) - True for active, False otherwise.

setAnimClipDuration(clip, frames)

Sets the frame duration of an animation clip.

Parameters:

clip (vrNodePtr) - The target clip.
frames (int) - The duration of the clip in frames.

setAnimClipEnd(clip, frame, keepStart)

Sets the end frame of an animation clip.

Parameters:

clip (vrNodePtr) - The target clip.
frame (int) - The end frame of the clip.
keepStart (bool) - If True the start frame will be kept and the length of the clip changes. The new end frame must be greater than the start frame.

setAnimClipFlipped(clip, flipped)

Flippes/Unflippes an animation clip.

Parameters:

clip (vrNodePtr) - The target clip.
flipped (bool) - True for flipped, False otherwise.

setAnimClipLocked(clip, locked)

Locked/Unlockes an animation clip.

Parameters:

clip (vrNodePtr) - The target clip.
locked (bool) - True for locked, False otherwise.

setAnimClipStart(clip, frame, keepEnd)

Sets the start frame of an animation clip.

Parameters:

clip (vrNodePtr) - The target clip.
frame (int) - The start frame of the clip.
keepEnd (bool) - If True the end frame will be kept and the length of the clip changes. The new start frame must be smaller than the end frame.

setCurrentFrame(frame)

Sets the current frame of the time line.

Parameters:

frame (Real64) - Frame

stopAnim(name)

Stops the animation evaluation of an animation block or animation clip via name.

Parameters:

name (string) - name of the animation object

trashAnimation(node)

Moves animation to trash.

Parameters:

node (NodePtr) - Animation node or parent object node

Returns: bool

True if trashed, false otherwise

trashAnimations(nodes)

Moves a list of animation to trash.

Parameters:

nodes (std::vector<vrNodePtr>) - Animation nodes or parent object nodes

Returns: bool

True if trashed, false otherwise