Related Scripting Object: Partition
A Partition is a division of a Pass, which behaves like a Group. Partitions are used to organize scene elements within a Pass. There are only two types of partitions: object and light. Light partitions can only contain lights, and object partitions can only contain geometric objects. More...
#include <xsi_partition.h>
Inheritance diagram for Partition:
Public Member Functions |
|
| Partition () | |
| ~Partition () | |
| Partition (const CRef &in_ref) | |
| Partition (const Partition &in_obj) | |
| bool | IsA (siClassID in_ClassID) const |
| siClassID | GetClassID () const |
| Partition & | operator= (const Partition &in_obj) |
| Partition & | operator= (const CRef &in_ref) |
| XSI::siPartitionType | GetPartitionType () const |
| bool | IsBackground () const |
Each pass created has at least two partitions: a background objects partition, which contains most or all of the scene's objects, and a background lights partition, which contains most or all of the scene's lights.
| Partition | ( | ) |
Default constructor.
| ~Partition | ( | ) |
Default destructor.
Constructor.
| in_ref | constant reference object. |
Copy constructor.
| in_obj | constant class object. |
| bool IsA | ( | siClassID | in_ClassID | ) | const [virtual] |
Returns true if a given class type is compatible with this API class.
| in_ClassID | class type. |
Reimplemented from Group.
| siClassID GetClassID | ( | ) | const [virtual] |
Returns the type of the API class.
Reimplemented from Group.
Creates an object from another object. The newly created object is set to empty if the input object is not compatible.
| in_obj | constant class object. |
Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.
| in_ref | constant class object. |
Reimplemented from Group.
| XSI::siPartitionType GetPartitionType | ( | ) | const |
Returns the Partition type. A partition can be either an object or a light partition.
| bool IsBackground | ( | ) | const |
Returns true if the Partition is a background partition. A background partition is an undeletable system partition where new objects and lights are added by default.