RenderMan API  23.0
RixSGClippingPlane Class Referenceabstract

#include <RixSceneGraph.h>

Inheritance diagram for RixSGClippingPlane:
RixSGGroup

Public Member Functions

virtual RixSGError SetActive (bool active)=0
 
virtual RixSGError SetOrientTransform (RtMatrix4x4 const &localxform)=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

 RixSGClippingPlane ()=default
 
virtual ~RixSGClippingPlane ()=default
 

Detailed Description

Clipping plane DAG node with arbitrary orientation.

Definition at line 733 of file RixSceneGraph.h.

Constructor & Destructor Documentation

◆ RixSGClippingPlane()

RixSGClippingPlane::RixSGClippingPlane ( )
inlineprotecteddefault

◆ ~RixSGClippingPlane()

virtual RixSGClippingPlane::~RixSGClippingPlane ( )
protectedvirtualdefault

Member Function Documentation

◆ SetActive()

virtual RixSGError RixSGClippingPlane::SetActive ( bool  active)
pure virtual

Enable clipping plane

Enable or disable the clipping behavior of the clipping plane. Enabled clipping planes clip primary visibility on the -Z side of the XY plane in the local coordinate system.

Parameters
[in]activetrue to enable, false to disable.
Returns
Error code

◆ SetOrientTransform()

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

Set orientation transform

Orientation transforms are static transforms that are applied to the clipping plane description but are not inherited as part of the DAG hierarchy. This is typically used to match one clipping plane orientation to another, e.g. clipping axis and direction.

Parameters
[in]localxformThe orientation transform
Returns
Error code

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