RenderMan API  23.0
RixSGCamera Class Referenceabstract

#include <RixSceneGraph.h>

Inheritance diagram for RixSGCamera:
RixSGGroup

Public Member Functions

virtual RixSGError SetRenderable (int renderable)=0
 
virtual RixSGError SetProjection (unsigned num, RixSGShader const *nodes)=0
 
virtual RixSGError SetDisplay (unsigned num, RixSGShader const *nodes)=0
 
virtual RixSGError SetOrientTransform (RtMatrix4x4 const &localxform)=0
 
virtual RtParamList const & GetProperties () const =0
 
virtual RixSGError SetProperties (RtParamList const &prop)=0
 
- Public Member Functions inherited from RixSGGroup
virtual RixSGDagType GetDagType () const =0
 
virtual RtUString GetIdentifier () const =0
 
virtual RixSGError SetIdentifier (RtUString identifier)=0
 
virtual RixSGError SetTransform (unsigned numsamples, RtMatrix4x4 const *xforms, float const *times)=0
 
virtual RixSGError SetTransformNumSamples (unsigned numsamples)=0
 
virtual RixSGError SetTransformSample (unsigned sample, RtMatrix4x4 const &xform, float time)=0
 
RixSGError SetTransform (RtMatrix4x4 const &xform)
 
RixSGError SetIdentity ()
 
virtual RixSGError SetHidden (int state)=0
 
virtual int GetHidden () const =0
 
virtual RixSGError AddCoordinateSystem (RixSGGroup *coordsys)=0
 
virtual RixSGError RemoveCoordinateSystem (RixSGGroup *coordsys)=0
 
virtual unsigned GetNumCoordinateSystems () const =0
 
virtual RixSGGroupGetCoordinateSystem (unsigned idx) const =0
 
virtual RixSGError AddChild (RixSGGroup *child)=0
 
virtual RixSGError RemoveChild (RixSGGroup *child)=0
 
virtual unsigned GetNumChildren () const =0
 
virtual RixSGGroupGetChild (unsigned idx) const =0
 
virtual unsigned GetNumParents () const =0
 
virtual RixSGGroupGetParent (unsigned idx) const =0
 
virtual RixSGGroupFindDagNode (char const *path) const =0
 
virtual RixSGMaterialGetMaterial () const =0
 
virtual RixSGError SetMaterial (RixSGMaterial *material)=0
 
virtual RixSGError OverrideMaterial (RixSGMaterial *material, unsigned depth, RixSGGroup **path)=0
 
virtual RtParamList const & GetAttributes () const =0
 
virtual RixSGError SetAttributes (RtParamList const &attributes)=0
 
virtual RixSGError SetNested (bool state)=0
 
virtual bool GetNested () const =0
 
virtual RixSGError SetInheritTransform (bool value)=0
 
 RixSGGroup ()=default
 
virtual ~RixSGGroup ()=default
 

Protected Member Functions

 RixSGCamera ()=default
 
virtual ~RixSGCamera ()=default
 

Detailed Description

Camera DAG node used for rendering and texture projections.

Definition at line 663 of file RixSceneGraph.h.

Constructor & Destructor Documentation

◆ RixSGCamera()

RixSGCamera::RixSGCamera ( )
inlineprotecteddefault

◆ ~RixSGCamera()

virtual RixSGCamera::~RixSGCamera ( )
protectedvirtualdefault

Member Function Documentation

◆ GetProperties()

virtual RtParamList const& RixSGCamera::GetProperties ( ) const
pure virtual

Get camera properties

Camera properties contain options that may vary per camera. For example, the near and far clipping distance.

See also
RixSGCamera::SetProperties
Returns
Camera properties

◆ SetDisplay()

virtual RixSGError RixSGCamera::SetDisplay ( unsigned  num,
RixSGShader const *  nodes 
)
pure virtual

Set display drivers

There may be one or more display drivers of type RixSGShaderType::k_Display. The default display driver is "it" and binds to all display channels.

See also
RixSGScene::SetDisplayChannel
Parameters
[in]numThe number of display drivers
[in]nodesThe display drivers
Returns
Error code

◆ SetOrientTransform()

virtual RixSGError RixSGCamera::SetOrientTransform ( RtMatrix4x4 const &  localxform)
pure virtual

Set orientation transform

Orientation transforms are static transforms that are applied to the camera description but are not inherited as part of the DAG hierarchy. This is typically used to match one camera model to another, e.g. cameras point down the +Z or -Z axis.

Parameters
[in]localxformThe orientation transform
Returns
Error code

◆ SetProjection()

virtual RixSGError RixSGCamera::SetProjection ( unsigned  num,
RixSGShader const *  nodes 
)
pure virtual

Set projection shading graph

Projection shading graph may contain a single terminal RixSGShaderType::k_Projection node. The default projection is "PxrPerspective" with an fov of 90 degrees.

Parameters
[in]numThe number of nodes in the shading graph
[in]nodesThe projection shading graph nodes
Returns
Error code

◆ SetProperties()

virtual RixSGError RixSGCamera::SetProperties ( RtParamList const &  prop)
pure virtual

Set camera properties

Camera properties contain options that may vary per camera. For example, the near and far clipping distance.

See also
RixSGCamera::GetProperties
Parameters
[in]propCamera properties
Returns
Error code

◆ SetRenderable()

virtual RixSGError RixSGCamera::SetRenderable ( int  renderable)
pure virtual

Set renderable mode

Renderable cameras are those that are used to generate outputs. The primary renderable camera is used as the default dicing camera. There may be only one primary renderable camera per scene. The default is non-renderable.

Parameters
[in]renderableRenderable mode: 0 (non-renderable), 1 (primary), 2 (renderable)
Returns
Error code

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