RenderMan API  23.0
RixSGVolume Class Referenceabstract

Volume geometry. More...

#include <RixSceneGraph.h>

Inheritance diagram for RixSGVolume:
RixSGGeometry RixSGGroup

Public Member Functions

virtual RixSGError Define (int32_t nx, int32_t ny, int32_t nz)=0
 
- Public Member Functions inherited from RixSGGeometry
virtual RtUString Geometry () const =0
 Return geometry type. More...
 
virtual RixSGError SetGeometry (RtUString type)=0
 
virtual RtParamList const & GetPrimVars () const =0
 
virtual RixSGError SetPrimVars (RtParamList const &primvars)=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

 RixSGVolume ()=default
 
virtual ~RixSGVolume ()=default
 
- Protected Member Functions inherited from RixSGGeometry
 RixSGGeometry ()=default
 
virtual ~RixSGGeometry ()=default
 

Detailed Description

Volume geometry.

Definition at line 955 of file RixSceneGraph.h.

Constructor & Destructor Documentation

◆ RixSGVolume()

RixSGVolume::RixSGVolume ( )
inlineprotecteddefault

◆ ~RixSGVolume()

virtual RixSGVolume::~RixSGVolume ( )
protectedvirtualdefault

Member Function Documentation

◆ Define()

virtual RixSGError RixSGVolume::Define ( int32_t  nx,
int32_t  ny,
int32_t  nz 
)
pure virtual

Define volume geometry

Volume geometry specifies a shaped volumetric region of space. The shape of the region is specified by the "type" primvar, which supports the values: "box", "ellipsoid", "cone", "cylinder", or blobbydso URI prefixed with "blobbydso:".

Detail type Size
constant 1
uniform 1
vertex nx * ny * nz
varying nx * ny * nz
facevarying nx * ny * nz
Parameters
[in]nxVoxel resolution in x
[in]nyVoxel resolution in y
[in]nzVoxel resolution in z
Returns
Error code

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