Project Class Reference

Search for all occurrences

#include <xsi_project.h>

---

Class Description

The Project object represents the active Softimage project. It exposes information like the current scene (see Project::GetActiveScene).

See also:

Scene, Application

Inheritance diagram for Project:

List of all members.

Public Member Functions
	Project ()
	~Project ()
	Project (const CRef &in_ref)
	Project (const Project &in_obj)
bool	IsA (siClassID in_ClassID) const
siClassID	GetClassID () const
Project &	operator= (const Project &in_obj)
Project &	operator= (const CRef &in_ref)
Scene	GetActiveScene () const
CRefArray	GetScenes () const
CRefArray	GetProperties () const
CString	GetPath () const

---

Constructor & Destructor Documentation

Project

(

)

Default constructor.

~Project

(

)

Default destructor.

Project

(

const CRef &

in_ref

)

Constructor.

Parameters:

in_ref

constant reference object.

Project

(

const Project &

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 SIObject.

siClassID GetClassID

(

)

const [virtual]

Search for all occurrences

Returns the type of the API class.

Returns:

The class type.

Reimplemented from SIObject.

Project& operator=

(

const Project &

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 Project object.

Project& 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 Project object.

Reimplemented from SIObject.

Scene GetActiveScene

(

)

const

Search for all occurrences

Return the currently active Scene object.

Returns:

The currently active scene.

CRefArray GetScenes

(

)

const

Search for all occurrences

Not-implemented.

Returns:

Array of Scene objects (not implemented).

CRefArray GetProperties

(

)

const

Search for all occurrences

Returns an array of reference to the properties installed on the Project.

Returns:

Array of references to Property objects.

CString GetPath

(

)

const

Search for all occurrences

Returns the path of the project.

Returns:

CString Path of the project.

Since:

5.0

---

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

• xsi_project.h