Pass Class Reference
This reference page is linked to from the following overview topics: Checking Return Values for Type.
#include <xsi_pass.h>
A render pass creates a picture layer of a scene that can be composited with any other pass to create a complete image. Passes also allow you to quickly re-render a single layer without re-rendering the entire scene. Later you can composite the rendered passes using the Softimage FX Tree, the fully-integrated compositing and effects toolset, or another compositing tool of your choice.
Each scene can contain as many render passes as you need. When
you first create a scene in Softimage, it has a single pass named
Default_pass. This is a "beauty pass" that is set to
render every element of the scene. You can render a single beauty
pass or you can render separate passes. Also, you can use preset
passes such as matte, shadow, toon, and highlight, or you can
create your own passes.
Public Member Functions |
|
| Pass () | |
| ~Pass () | |
| Pass (const CRef &in_ref) | |
| Pass (const Pass &in_obj) | |
| bool | IsA (siClassID in_ClassID) const |
| siClassID | GetClassID () const |
| Pass & | operator= (const Pass &in_obj) |
| Pass & | operator= (const CRef &in_ref) |
| CRefArray | GetFramebuffers () |
| Framebuffer | CreateFramebuffer (const CString &in_channelName) |
| Framebuffer | CreateFramebuffer (RenderChannel &in_renderChannel) |
| CLongArray | GetFrames () |
| CString | GetResolvedArchivePath (const CTime &in_rTime) |
| CString | GetResolvedArchivePath () |
| Renderer | GetRenderer () const |
| CRefArray | GetPartitions () const |
| Partition | CreatePartition (const CString &in_name, XSI::siPartitionType in_type) |
| CRefArray | GetAllShaders () const |
| CRefArray | GetAllImageClips () const |
| Pass | ( | ) |
Default constructor.
| ~Pass | ( | ) |
Default destructor.
| 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 SceneItem.
| siClassID GetClassID | ( | ) | const [virtual] |
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. |
| CRefArray GetFramebuffers | ( | ) |
Returns a list of Framebuffer objects on the pass. The framebuffers control which RenderChannel objects the pass will output to disk.
| Framebuffer CreateFramebuffer | ( | const CString & | in_channelName | ) |
Adds a new framebuffer to the pass based on the named RenderChannel. The render channel has to exist, otherwise no framebuffer is added.
| in_channelName | Name of the render channel to base the new framebuffer on. |
| Framebuffer CreateFramebuffer | ( | RenderChannel & | in_renderChannel | ) |
Adds a new framebuffer to the pass based on the specified render channel.
| in_renderChannel | The RenderChannel object to base the new framebuffer on. |
| CLongArray GetFrames | ( | ) |
Returns the list of frame numbers that are going to be rendered
by this pass. The list depends on the Pass parameters
FrameRangeSource, FrameSet,
FrameStep, FrameStart, and
FrameEnd.
Takes the output archive path template given in the pass and resolves it to a real path name for the specified time. See section "Output Path Templates" in the Softimage User Guide for more details.
| in_rTime | The time at which to resolve the path template. Controls the result of the [Frame] and [Field] tokens. |
| CString GetResolvedArchivePath | ( | ) |
Takes the output archive path template given in the pass and
resolves it to a time-independent path, where any instance of
[Frame] is substituted with the a sequence of #
symbols, that represent the current frame number and padding width.
See section "Output Path Templates" in the Softimage User Guide for
more details.
| Renderer GetRenderer | ( | ) | const |
Returns the rendering engine selected for use for this pass.
| CRefArray GetPartitions | ( | ) | const |
Returns a list of all Partition objects that exist on this pass. This includes all object and light partitions, whether they're background or not.
| Partition CreatePartition | ( | const CString & | in_name, |
| XSI::siPartitionType | in_type | ||
| ) |
Creates a new Partition and adds it to this Pass.
| in_name | The name of the partition to create. If a partition already exists with the same name, the new partition's name will be modified to avoid a naming clash. |
| in_type | The type of partition to create. |
| CRefArray GetAllImageClips | ( | ) | const |
Returns a list of the image clips nested under this Pass.