#include <RixSceneGraph.h>
RixInterface for constructing and manipulating scene graphs
Definition at line 1153 of file RixSceneGraph.h.
◆ RixSGScene()
RixSGScene::RixSGScene |
( |
| ) |
|
|
protecteddefault |
◆ ~RixSGScene()
virtual RixSGScene::~RixSGScene |
( |
| ) |
|
|
protectedvirtualdefault |
◆ Clear()
◆ CreateAnalyticLight()
◆ CreateBlobby()
◆ CreateCamera()
◆ CreateClippingPlane()
◆ CreateCurves()
◆ CreateGeometry()
◆ CreateGroup()
◆ CreateMaterial()
◆ CreateMesh()
◆ CreateNuPatch()
◆ CreatePoints()
◆ CreateProcedural()
◆ CreateQuadric()
◆ CreateVolume()
◆ DeleteDagNode()
Delete a DAG node.
The DAG node is removed from the scene graph. It is invalid to dereference a DAG node once deleted.
- See also
- RixSGScene::Clear
- Parameters
-
- Returns
- Error code
◆ DeleteMaterial()
◆ EditBegin()
virtual void RixSGScene::EditBegin |
( |
| ) |
|
|
pure virtual |
Start an edit block
An edit block defines a time during which the scene graph may be safely modified without renderer synchronization. Edit blocks may be nested.
- See also
- RixSGScene::ScopedEdit
◆ EditEnd()
virtual void RixSGScene::EditEnd |
( |
| ) |
|
|
pure virtual |
Finish an edit block
An edit block defines a time during which the scene graph may be safely modified without renderer synchronization. Edit blocks may be nested.
- See also
- RixSGScene::ScopedEdit
◆ FindDagNode()
virtual RixSGGroup* RixSGScene::FindDagNode |
( |
char const * |
path | ) |
const |
|
pure virtual |
Find a DAG node from a identifier path
Returns a DAG node based on the string identifier path relative to the root node. DAG node paths should use the same separator given to RixSGManager::CreateScene.
- See also
- RixSGGroup::SetIdentifier
- Parameters
-
- Returns
- DAG node or nullptr when path is invalid
◆ GetOptions()
virtual RtParamList const& RixSGScene::GetOptions |
( |
| ) |
const |
|
pure virtual |
Get option list
Parameters that are globally availible to all scene objects and instances are called options. Options must be set before render begins and are constant for all primitives. Options define scene properties such as searchpaths, resolution, user parameters.
- See also
- RixSGScene::SetOptions
- Returns
- Option list
◆ Render()
virtual RixSGError RixSGScene::Render |
( |
char const * |
cmd | ) |
|
|
pure virtual |
Start a live render, batch render, or scene export
Command mode may be "prman" to render or "rib" to export RIB. Renders may be stopped by calling RixSGScene::Stop. The render mode flags supports several flags:
Flag | Description |
"-live" | Interactive rendering supporting scene edits |
"-blocking" | Call blocks unitl stopped or converged |
For example:
scene->Render("prman -live");
scene->Render("prman -blocking");
scene->Render("rib /path/to/output.rib");
- See also
- RixSGScene::Stop
- Parameters
-
[in] | cmd | Render command and flags |
- Returns
- Error code
◆ Root()
◆ SetDisplayChannel()
Set display channels
You may specify one or more display channels. These are applied to all renderable cameras. The default display channels are 'Ci' and 'a' (beauty and alpha)
- Parameters
-
[in] | num | The number of channels |
[in] | nodes | The display channels |
- Returns
- Error code
◆ SetDisplayFilter()
Set display filter shading graph
You may specify one or more RixDisplayFilter plug-ins that may be networked. Only the root node will be evaluated by the renderer. There is no default display filter plug-in.
- Parameters
-
[in] | num | The number of nodes |
[in] | nodes | The displayfilter nodes |
- Returns
- Error code
◆ SetIntegrator()
Set integrator shading graph
Integrators take the camera rays from the projection and return shaded results to the renderer. Integrator shading graphs may contain a single terminal RixSGShaderType::k_Integrator node. The default integrator is "PxrDefault".
- Parameters
-
[in] | num | The number of nodes in the shading graph |
[in] | nodes | The integrator nodes |
- Returns
- Error code
◆ SetOptions()
Set option list
Parameters that are globally availible to all scene objects and instances are called options. Options must be set before render begins and are constant for all primitives. Options define scene properties such as searchpaths, resolution, user parameters.
- See also
- RixSGScene::GetOptions
- Parameters
-
- Returns
- Error code
◆ SetSampleFilter()
Set sample filter shading graph
Sample filter shading graphs may contain zero or more RixSGShaderType::k_SampleFilter nodes. You may specify one or more RixSampleFilter plug-ins that may be networked. Only the root node will be evaluated by the renderer. There is no default sample filter plug-in.
- Parameters
-
[in] | num | The number of nodes |
[in] | nodes | The samplefilter nodes |
- Returns
- Error code
◆ SetUpdateIdCallback()
Optional callback to provide the object ids
If this callback is set then is it queried for integer attributes "identifier:id" and "identifier:id2" values that will be rendered into the "id" channel.
- Parameters
-
[in] | callback | The function to be called when ever an object is created/modified |
[in] | ctx | User context quoted back to the callback |
- Returns
- Error code
◆ Stop()
Stop a live render
This blocking call returns once the renderer has fully stopped.
- See also
- RixSGScene::Render
- Returns
- Error code
The documentation for this class was generated from the following file: