TaggedParameters (ProjectItem)
Introduced
4.0
Description
Returns a collection of Parameter objects containing all parameters tagged by the specified tag. This function can return local as well as nested parameters.
The tagging system helps you set a collection of parameters. Tags are persisted with a scene, so you never lose them. You can use this method to get a set of parameters in order to pass it to a command.
Note: Because this method returns all tagged parameters for the object and its children, use this method carefully on models (such as the scene root).
Scripting Syntax
ProjectItem.TaggedParameters( [Tag], [Local] )
C# Syntax
ParameterCollection ProjectItem.TaggedParameters( siTags, Boolean );Parameters
|
Parameter |
Type |
Description |
|
Tag |
The tags to look for. This can be a combination of tags. When a parameter supports at least one of the tags specified in an argument, it is added to the return list. Default Value: siTagAll |
|
|
Local |
Specifies whether the tag to check is local to the object or not. If true then all tagged parameters that come from propagated properties or from intermediate nodes are ignored (referenced parameters). Intermediate nodes are nested under the object but are not necessary owned by the object itself. For instance, the camera object nested under a Texture_Projection_Def property is not considered unless the target object is the projection property itself. When the argument is set to false (default), all parameters are considered. Default Value: False |
Return Value
See Also
Examples
• See ProjectItem.TaggedParameters.1.js
Autodesk Softimage 2011