AddProperty (SceneItem)
Description
Creates and adds a Property to a SceneItem object.
Notice that some cluster property types can only be added to Cluster objects that are always-complete (see Cluster.IsAlwaysComplete). These restrictions and others are listed in the Possible Values section for the Preset argument.
Scripting Syntax
SceneItem.AddProperty( Preset, [BranchFlag], [Name] )
C# Syntax
Property SceneItem.AddProperty( Object in_Preset, Boolean in_Branch, String in_name );Parameters
|
Parameter |
Type |
Description |
|
Preset |
This argument contains either the name of a Property Preset or a string with the filename or full path to a Preset file. Not all presets are valid for all SceneItem objects: restrictions are listed on these individual preset type pages (ClusterProperty Presets, CustomProperty Presets, Property (Object) Presets, UserDataBlob Presets, and UserDataMap Presets). The type of property that is created is determined by this argument. For example, "CustomProperty" creates an empty CustomProperty and "UserDataBlob" creates a UserDataBlob. |
|
|
BranchFlag |
When true the newly created Property will also appear under all the nested objects beneath the SceneItem Default Value: false |
|
|
Name |
Represents the name of the new property (see SIObject.Name). |
Return Value
ClusterProperty, CustomProperty, Property, UserDataBlob or UserDataMap, depending on the preset that was used.
See Also
|
|
Examples
• See SceneItem.AddProperty.1.js
• See SceneItem.AddProperty.2.vbs
Autodesk Softimage 2011