RixSceneGraph.h File Reference

#include "RiTypesHelper.h"
#include "RixInterfaces.h"

Go to the source code of this file.

Classes
struct	DisplayChannel
	Scene graph display channel description. More...
struct	Shader
	Scene graph shader node descriptions. More...
class	Material
	Scene graph material description. More...
class	Group
	Base class for scene graph DAG nodes. More...
class	Camera
	Camera DAG node used for rendering and texture projections. More...
class	ClippingPlane
	Clipping plane DAG node with arbitrary orientation. More...
class	AnalyticLight
	Analytic light DAG node support RixLight plug-ins. More...
class	Geometry
	Special geometry DAG node. More...
class	Quadric
	Quadric geometry DAG node. More...
class	Mesh
	Polygon or subdivision mesh. More...
class	Points
	Points DAG node. More...
class	Volume
	Volume geometry. More...
class	Blobby
	Blobby Implicit Surfaces. More...
class	Curves
	Curves. More...
class	NuPatch
	NuPatch. More...
class	Procedural
	Procedural primitive. More...
class	Scene
	RixInterface for constructing and manipulating scene graphs. More...
struct	Scene::ScopedEdit
	Define scoped edit block. More...
class	RixSGManager
	Entry point for constructing and manipulating scene graphs. More...

Namespaces
	stats

Constant Groups
	stats

Macros
#define	k_RixSGManagerVersion   3
#define	RMAN_SCENEGRAPH_NAMESPACE   scenegraph
#define	RMAN_SCENEGRAPH_NAMESPACE_OPEN_SCOPE
#define	RMAN_SCENEGRAPH_NAMESPACE_CLOSE_SCOPE   }

Typedefs
typedef uint64_t(*	UpdateIdCallback )(void *ctx, Group const *node, RtUString const &path)
	Callback type used to optionally set object ids. More...
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Blobby	RixSGBlobby
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Camera	RixSGCamera
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::ClippingPlane	RixSGClippingPlane
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Curves	RixSGCurves
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::DagType	RixSGDagType
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::DisplayChannel	RixSGDisplayChannel
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Error	RixSGError
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Geometry	RixSGGeometry
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Group	RixSGGroup
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Material	RixSGMaterial
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Mesh	RixSGMesh
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::NuPatch	RixSGNuPatch
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Points	RixSGPoints
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Procedural	RixSGProcedural
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Quadric	RixSGQuadric
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Scene	RixSGScene
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Shader	RixSGShader
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::ShaderType	RixSGShaderType
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::UpdateIdCallback	RixSGUpdateIdCallback
typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Volume	RixSGVolume

Enumerations
enum	Error { Error::k_Success, Error::k_InvalidState, Error::k_InvalidInput }
	Scene graph error codes. More...
enum	DagType {   DagType::k_Group, DagType::k_Camera, DagType::k_ClippingPlane, DagType::k_AnalyticLight,   DagType::k_Geometry, DagType::k_Quadric, DagType::k_Mesh, DagType::k_NuPatch,   DagType::k_Curves, DagType::k_Points, DagType::k_Blobby, DagType::k_Volume,   DagType::k_Procedural }
	Scene graph DAG node types. More...
enum	ShaderType {   ShaderType::k_Invalid, ShaderType::k_Pattern, ShaderType::k_Bxdf, ShaderType::k_Integrator,   ShaderType::k_Light, ShaderType::k_LightFilter, ShaderType::k_Projection, ShaderType::k_Displacement,   ShaderType::k_SampleFilter, ShaderType::k_DisplayFilter, ShaderType::k_Display }
	Scene graph shading node types. More...

Variables
RMAN_SCENEGRAPH_NAMESPACE_CLOSE_SCOPE RMAN_NAMESPACE_CLOSE_SCOPE typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::AnalyticLight	RixSGAnalyticLight

Macro Definition Documentation

#define k_RixSGManagerVersion   3

#define RMAN_SCENEGRAPH_NAMESPACE   scenegraph

#define RMAN_SCENEGRAPH_NAMESPACE_CLOSE_SCOPE   }

#define RMAN_SCENEGRAPH_NAMESPACE_OPEN_SCOPE

Value:

namespace RMAN_SCENEGRAPH_NAMESPACE      \
    {

Typedef Documentation

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Blobby RixSGBlobby

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Camera RixSGCamera

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::ClippingPlane RixSGClippingPlane

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Curves RixSGCurves

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::DagType RixSGDagType

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::DisplayChannel RixSGDisplayChannel

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Error RixSGError

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Geometry RixSGGeometry

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Group RixSGGroup

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Material RixSGMaterial

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Mesh RixSGMesh

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::NuPatch RixSGNuPatch

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Points RixSGPoints

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Procedural RixSGProcedural

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Quadric RixSGQuadric

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Scene RixSGScene

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Shader RixSGShader

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::ShaderType RixSGShaderType

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::UpdateIdCallback RixSGUpdateIdCallback

typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::Volume RixSGVolume

typedef uint64_t(* UpdateIdCallback)(void *ctx, Group const *node, RtUString const &path)

Callback type used to optionally set object ids.

Enumeration Type Documentation

enum DagType

strong

Scene graph DAG node types.

Enumerator
k_Group	Grouping and transformations. See Also Group
k_Camera	Cameras. See Also Camera
k_ClippingPlane	Clipping planes. See Also ClippingPlane
k_AnalyticLight	Analytic lights. See Also AnalyticLight
k_Geometry	Special geometry. See Also Geometry
k_Quadric	Quadric geometry, e.g. spheres. See Also Quadric
k_Mesh	Polygon and subdivision meshes. See Also Mesh
k_NuPatch	Nurbs patches. See Also NuPatch
k_Curves	Hair, ribbion, and curve geometry. See Also Curves
k_Points	Point particle and disk geometry. See Also Points
k_Blobby	Implicit surface geometry. See Also Blobby
k_Volume	Volume geometry. See Also Volume
k_Procedural	Custom proceudral geometry. See Also Procedural

enum Error

strong

Scene graph error codes.

Enumerator
k_Success	No error.
k_InvalidState	Operation not permitted in current state.
k_InvalidInput	Operation input is invalid.

enum ShaderType

strong

Scene graph shading node types.

Enumerator
k_Invalid	Invalid shading node.
k_Pattern	Textural pattern. See Also RixPattern
k_Bxdf	Surface, subsurface, volumetric scattering. See Also RixBxdfFactory
k_Integrator	Integrator. See Also RixIntegrator
k_Light	Analytic and geometric light emission. See Also RixLightFactory
k_LightFilter	Light emission filter. See Also RixLightFilter
k_Projection	Camera projection. See Also RixProjectionFactory
k_Displacement	Surface displacement. See Also RixDisplacementFactory
k_SampleFilter	Primary sample filter. See Also RixSampleFilter
k_DisplayFilter	Pixel filter. See Also RixDisplayFilter
k_Display	Output display driver. See Also ndspy.h

Variable Documentation

RMAN_SCENEGRAPH_NAMESPACE_CLOSE_SCOPE RMAN_NAMESPACE_CLOSE_SCOPE typedef RMAN_NAMESPACE::RMAN_SCENEGRAPH_NAMESPACE::AnalyticLight RixSGAnalyticLight