HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
DM_RenderTable Class Reference

#include <DM_RenderTable.h>

Public Member Functions

bool registerGTHook (GUI_PrimitiveHook *hook, GT_PrimitiveType type, int priority, GUI_PrimitiveHookFlags flags=GUI_HOOK_FLAG_NONE, int hook_ver=GUI_PRIMITIVE_HOOK_VERSION)
 Register a geometry primitive render hook Register a primitive hook that uses a GT_Primitive as its source. type Specifies the type of GT primitive this hook is intended for priority If more than one hook is present for the same GT type, the higher of the two priorities is processed first. MAX_INT is reserved, otherwise any integer is valid. flags Special options for the hook: GUI_HOOK_FLAG_COLLECT_PRIMS: Collect all (or some) of the primitives matching 'type' into a single GR_Primitive hook_ver Leave at its default. This will notify you if a hook needs to be recompiled. returns true if the hook was sucessfully registered. More...
 
bool registerGEOHook (GUI_PrimitiveHook *hook, GA_PrimitiveTypeId geo_type, int priority, GUI_PrimitiveHookFlags flags=GUI_HOOK_FLAG_NONE, int hook_ver=GUI_PRIMITIVE_HOOK_VERSION)
 Register a geometry primitive render hook Register a primitive hook that uses a GEO_Primitive as its source. geo_type Specifies the geometry type this hook is intended for. priority If more than one hook is present for the same GT type, the higher of the two priorities is processed first. MAX_INT is reserved, otherwise any integer is valid. flags Special options for the hook: GUI_HOOK_FLAG_COLLECT_PRIMS: Collect all (or some) of the primitives matching 'type' into a single GR_Primitive hook_ver Leave at its default. This will notify you if a hook needs to be recompiled. returns true if the hook was sucessfully registered. More...
 
bool registerSceneHook (DM_SceneHook *hook, DM_SceneHookType type, DM_SceneHookPolicy policy, int hook_ver=DM_SCENE_HOOK_VERSION)
 Register a scene render hook Register a scene hook that is associated with a specific render pass. type The rendering task this hook creates render hooks for. policy How the hook interacts with native Houdini rendering hook_ver Leave at its default. This will notify you if a hook needs to be recompiled. returns true if the hook was successfully rgistered. More...
 
bool installGeometryOption (const char *vis_name, const char *vis_label=NULL, GUI_GeometryOptionFlags flags=GUI_GEO_OPT_NONE)
 Install a new scene file visualizer for all geometry contexts Installs a generic visualizer that can be enabled individually for the various contexts, such as Scene Object and Current Geometry. The vis_name is the name used by commands to reference the option, while the vis_label is the English readable name. If not given, the vis_name will be used as the readable name as well. If the visualizer already exists, it will not create it and false is returned. If successful, true is returned. More...
 
bool installSceneOption (const char *vis_name, const char *vis_label=NULL)
 Install a new scene file visualizer for controlling scene hooks Install a new scene file generic visualizer untied to any geometry context. This can be used to control scene hooks more easily. The vis_name is the name used by commands to reference the visualizer, while the vis_label is the English readable name. If not given, the vis_name will be used as the readable name as well. If the visualizer already exists, it will not create it and return false. Otherwise true is returned. More...
 

Static Public Member Functions

static DM_RenderTablegetTable ()
 

Friends

class DM_Viewport
 

Detailed Description

Member Function Documentation

static DM_RenderTable* DM_RenderTable::getTable ( )
static
bool DM_RenderTable::installGeometryOption ( const char *  vis_name,
const char *  vis_label = NULL,
GUI_GeometryOptionFlags  flags = GUI_GEO_OPT_NONE 
)

Install a new scene file visualizer for all geometry contexts Installs a generic visualizer that can be enabled individually for the various contexts, such as Scene Object and Current Geometry. The vis_name is the name used by commands to reference the option, while the vis_label is the English readable name. If not given, the vis_name will be used as the readable name as well. If the visualizer already exists, it will not create it and false is returned. If successful, true is returned.

Examples:
GUI/GUI_PolygonNormalShade.C, GUI/GUI_PolySoupBox.C, and GUI/GUI_PrimFramework.C.
bool DM_RenderTable::installSceneOption ( const char *  vis_name,
const char *  vis_label = NULL 
)

Install a new scene file visualizer for controlling scene hooks Install a new scene file generic visualizer untied to any geometry context. This can be used to control scene hooks more easily. The vis_name is the name used by commands to reference the visualizer, while the vis_label is the English readable name. If not given, the vis_name will be used as the readable name as well. If the visualizer already exists, it will not create it and return false. Otherwise true is returned.

Examples:
DM/DM_BackgroundHook.C, DM/DM_InfoHook.C, DM/DM_LightBloomHook.C, DM/DM_ObjectPathHook.C, DM/DM_OverdrawHook.C, and DM/DM_SceneBoundsHook.C.
bool DM_RenderTable::registerGEOHook ( GUI_PrimitiveHook hook,
GA_PrimitiveTypeId  geo_type,
int  priority,
GUI_PrimitiveHookFlags  flags = GUI_HOOK_FLAG_NONE,
int  hook_ver = GUI_PRIMITIVE_HOOK_VERSION 
)

Register a geometry primitive render hook Register a primitive hook that uses a GEO_Primitive as its source. geo_type Specifies the geometry type this hook is intended for. priority If more than one hook is present for the same GT type, the higher of the two priorities is processed first. MAX_INT is reserved, otherwise any integer is valid. flags Special options for the hook: GUI_HOOK_FLAG_COLLECT_PRIMS: Collect all (or some) of the primitives matching 'type' into a single GR_Primitive hook_ver Leave at its default. This will notify you if a hook needs to be recompiled. returns true if the hook was sucessfully registered.

Examples:
GUI/GUI_PolySoupBox.C, GUI/GUI_PrimFramework.C, GUI/GUI_PrimVolumeVelField.C, and tetprim/GEO_PrimTetra.C.
bool DM_RenderTable::registerGTHook ( GUI_PrimitiveHook hook,
GT_PrimitiveType  type,
int  priority,
GUI_PrimitiveHookFlags  flags = GUI_HOOK_FLAG_NONE,
int  hook_ver = GUI_PRIMITIVE_HOOK_VERSION 
)

Register a geometry primitive render hook Register a primitive hook that uses a GT_Primitive as its source. type Specifies the type of GT primitive this hook is intended for priority If more than one hook is present for the same GT type, the higher of the two priorities is processed first. MAX_INT is reserved, otherwise any integer is valid. flags Special options for the hook: GUI_HOOK_FLAG_COLLECT_PRIMS: Collect all (or some) of the primitives matching 'type' into a single GR_Primitive hook_ver Leave at its default. This will notify you if a hook needs to be recompiled. returns true if the hook was sucessfully registered.

Examples:
GUI/GUI_PolygonNormalShade.C, and GUI/GUI_PrimFramework.C.
bool DM_RenderTable::registerSceneHook ( DM_SceneHook hook,
DM_SceneHookType  type,
DM_SceneHookPolicy  policy,
int  hook_ver = DM_SCENE_HOOK_VERSION 
)

Register a scene render hook Register a scene hook that is associated with a specific render pass. type The rendering task this hook creates render hooks for. policy How the hook interacts with native Houdini rendering hook_ver Leave at its default. This will notify you if a hook needs to be recompiled. returns true if the hook was successfully rgistered.

Examples:
DM/DM_BackgroundHook.C, DM/DM_InfoHook.C, DM/DM_LightBloomHook.C, DM/DM_ObjectPathHook.C, DM/DM_OverdrawHook.C, and DM/DM_SceneBoundsHook.C.

Friends And Related Function Documentation

friend class DM_Viewport
friend

Definition at line 125 of file DM_RenderTable.h.


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