Property

Object Hierarchy | Related C++ Class: Property

Inheritance

SIObject
   ProjectItem
       Property

Description

The Property object represents a property of a SceneItem. For example, Softimage objects which have Properties include X3DObject, Model, Null, XSIProject, Group, Scene and Cluster.

Note: It is important to distinguish between the Softimage Property, which is a specific type of object, and the properties that are part of a scripting object's API (along with its methods). Similarily it is important to distinguish this object from Softimage Parameter objects, which are usually individual numeric attributes of an object. One visual way to think of the difference is to realise that a Property is represented by a Property Page and its Parameters are the individual sliders on that page.

Some properties, for example Visibility and Geometry Approximation, do not have specific objects in the Object Model and are represented with this Property object. Other Properties have their own specialized objects which inherit from Property, for example Material, ClusterProperty, UserDataMap, CustomProperty and StaticKinematicState.

A Property object may be local or shared. The SceneItem.LocalProperties property is convenient for finding just the local Properties on the parent object. The MakeLocal command can be used to make a local copy of a shared Property. The ProjectItem.Owners property can be used to find all owners of a shared Property. Because a shared property has multiple parents, the SIObject.Parent property can return different objects, depending on the context.

Often, the state of a Property object is exposed as Parameter objects. Other state is exposed as specific properties on the object, for example ClusterProperty.Elements and Material.CurrentImageClip.

Methods

AddCustomOp

AddScriptedOp

AddScriptedOpFromFile

AnimatedParameters2

BelongsTo

EvaluateAt

GetICEAttributeFromName

IsA

IsAnimated2

IsClassOf

IsEqualTo

IsKindOf

IsLocked

IsSelected

LockOwners

SetAsSelected

SetCapabilityFlag

SetLock

TaggedParameters

UnSetLock

Properties

Application

Branch

BranchFlag

Capabilities

Categories

EvaluationID

Families

FullName

Help

HierarchicalEvaluationID

ICEAttributes

LockLevel

LockMasters

LockType

Model

Name

NestedObjects

ObjectID

Origin

OriginPath

Owners

Parameters

Parent

Parent3DObject

PPGLayout

Selected

Singleton

Type

See Also

SceneItem.AddProperty

SceneItem.Properties

SceneItem.LocalProperties

Scene.Properties

XSIProject.Properties

 

 

 

Examples

• See Property.1.vbs

• See Property.2.vbs



Autodesk Softimage 2011