AnimatedParameters (ProjectItem)

Description

Returns a collection of Parameter objects for all parameters animated by a specific animation source type. This function can return local, and nested parameters. Note: Because this method returns all animated parameters for the object and its children, this can be very expensive if used on a model (such as the scene root). Use X3DObject.NodeAnimatedParameters to get the animated parameters for the object only.

Scripting Syntax

ProjectItem.AnimatedParameters( [sourceType] )

C# Syntax

ParameterCollection ProjectItem.AnimatedParameters( siSourceType );

Parameters

Parameter

Type

Description

sourceType

siSourceType

Animation source type. siShapeAnimationSource is only supported by X3DObject.

Default Value: siAnySource

Return Value

ParameterCollection

Examples

VBScript Example

set oRoot = Application.ActiveProject.ActiveScene.Root
set oCube = oRoot.AddGeometry( "Cube", "MeshSurface" )
set oCluster = oCube.ActivePrimitive.Geometry.AddCluster(siVertexCluster)
Application.LogMessage "IsAnimated( siAnySource )" & oCluster.IsAnimated( siAnySource )
for each p in oCluster.AnimatedParameters( siAnySource )
   Application.LogMessage p.Name
next

See Also

ProjectItem.IsAnimated

ProjectItem.IsAnimated2

ProjectItem.AnimatedParameters2

X3DObject.IsNodeAnimated

X3DObject.NodeAnimatedParameters

Parameter.IsAnimated

Parameter.AnimatedParameters

 



SOFTIMAGE|XSI v6.01     

Return to Softimage XSI Index