Property Class Reference

This reference page is linked to from the following overview topics: Callbacks for Self-Installing Plug-ins, Checking Return Values for Type.

---

Search for all occurrences

#include <xsi_property.h>

---

Class Description

The Property class represents the property of the following entities:

• X3DObject
• Model
• Null
• Project
• Group
• Scene
• Cluster

Properties are created with SceneItem::AddProperty.

See also:

siBranchFlag, SceneItem::GetProperties, SceneItem::GetLocalProperties, Group::GetProperties, Scene::GetProperties, Project::GetProperties

Example:

                using namespace XSI;
                Application app;
                Model root = app.GetActiveSceneRoot();

                Null myNull;
                root.AddNull( L"", myNull );

                Property myProp;
                myNull.AddProperty(L"Custom_parameter_list", false, L"MyCustomParam", myProp);
                app.LogMessage( L"Null's custom property name: " +
                                                myProp.GetFullName() );

Inheritance diagram for Property:

List of all members.

Public Member Functions
	Property ()
	~Property ()
	Property (const CRef &in_ref)
	Property (const Property &in_obj)
bool	IsA (siClassID in_ClassID) const
siClassID	GetClassID () const
Property &	operator= (const Property &in_obj)
Property &	operator= (const CRef &in_ref)
bool	GetSingleton () const
bool	GetBranch () const
CStatus	PutBranch (bool in_bState)

---

Constructor & Destructor Documentation

Property

(

)

Default constructor.

~Property

(

)

Default destructor.

Property

(

const CRef &

in_ref

)

Constructor.

Parameters:

in_ref

constant reference object.

Property

(

const Property &

in_obj

)

Copy constructor.

Parameters:

in_obj

constant class object.

---

Member Function Documentation

bool IsA

(

siClassID

in_ClassID

)

const [virtual]

Search for all occurrences

Returns true if a given class type is compatible with this API class.

Parameters:

in_ClassID

class type.

Returns:

true if the class is compatible, false otherwise.

Reimplemented from ProjectItem.

Reimplemented in ClusterProperty, Constraint, CustomProperty, EnvelopeWeight, Joint, Kinematics, Material, Override, ParticleType, SceneRenderProperty, ShapeKey, StaticKinematicState, TimeControl, UserDataBlob, UserDataMap, and UVProperty.

siClassID GetClassID

(

)

const [virtual]

Search for all occurrences

Returns the type of the API class.

Returns:

The class type.

Reimplemented from ProjectItem.

Reimplemented in ClusterProperty, Constraint, CustomProperty, EnvelopeWeight, Joint, Kinematics, Material, Override, ParticleType, SceneRenderProperty, ShapeKey, StaticKinematicState, TimeControl, UserDataBlob, UserDataMap, and UVProperty.

Property& operator=

(

const Property &

in_obj

)

Creates an object from another object. The newly created object is set to empty if the input object is not compatible.

Parameters:

in_obj

constant class object.

Returns:

The new Property object.

Property& operator=

(

const CRef &

in_ref

)

Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.

Parameters:

in_ref

constant class object.

Returns:

The new Property object.

Reimplemented from ProjectItem.

Reimplemented in ClusterProperty, Constraint, CustomProperty, EnvelopeWeight, Joint, Kinematics, Material, Override, ParticleType, SceneRenderProperty, ShapeKey, StaticKinematicState, TimeControl, UserDataBlob, UserDataMap, and UVProperty.

bool GetSingleton

(

)

const

Search for all occurrences

Returns true if only one object of this type is allowed on its parent.

Returns:

true if Singleton.

bool GetBranch

(

)

const

Search for all occurrences

Returns true if a property is applied to the branch of its parent.

Note:

Only getting the branch property is operator compliant. You cannot change the branch property if you are inside an operator.

Returns:

true if property is applied on branch.

CStatus PutBranch

(

bool

in_bState

)

Search for all occurrences

Sets the property branch state.

Note:

Not implemented.

Parameters:

in_bState

Branch state

Returns:

CStatus::OK success

CStatus::Fail failure

---

The documentation for this class was generated from the following file:

• xsi_property.h