Class SBGRenderNode#

#include <SBGRenderNode.hpp>

Inherits the following classes: SBCReferenceTarget

Inherited by the following classes: SBGRenderStructuralModel

Public Types#

Type	Name
enum	Type

Public Functions#

Type	Name
virtual void	display (SBNode::RenderingPass renderingPass) = 0 Display the node.
virtual void	forEachNodeDepthFirst (void()(SBGRenderNode* *node) action)
virtual void	forEachNodeDepthFirst (SBCClass * object, void(SBCClass::)(SBGRenderNode* *node) action)
virtual void	getNodes (std::vector< SBGRenderNode * > & selection)
virtual void	getNodes (std::vector< SBGRenderNode * > & selection, SBGRenderNode::Type type)
virtual void	getNodes (std::vector< SBGRenderNode * > & selection, bool()(SBGRenderNode* *) selectionRule)
virtual void	getNodes (std::vector< SBGRenderNode * > & selection, bool()(SBGRenderNode* ) visitRule, bool()(SBGRenderNode *) selectionRule)
virtual SBGRenderNode *	getParent () const Return parent of the render node.
virtual Type	getType () const Return type of the render node.
virtual void	print (unsigned int offset=0) const Print debug information.
virtual void	requestViewportUpdate () Request a viewport update.

Public Functions inherited from SBCReferenceTarget#

See SBCReferenceTarget

Type	Name
	SBCReferenceTarget ()
unsigned int	getMemoryFootprint () const
void	printReferencesToOwners () const
virtual	~SBCReferenceTarget ()

Public Static Functions#

Type	Name
void	forEachNodeInSelection (std::vector< SBGRenderNode * > & selection, void()(SBGRenderNode* *node) action)
void	forEachNodeInSelection (std::vector< SBGRenderNode * > & selection, SBCClass * object, void(SBCClass::)(SBGRenderNode* *node) action)
std::string	getTypeString (Type type) Return string representation of the type of the render node.

Protected Attributes inherited from SBCReferenceTarget#

See SBCReferenceTarget

Type	Name
SBCReferenceTargetData *	dataPointer

Protected Functions#

Type	Name
	SBGRenderNode () Build a base object.
virtual	~SBGRenderNode ()

Protected Functions inherited from SBCReferenceTarget#

See SBCReferenceTarget

Type	Name
	SBCReferenceTarget (SBCReferenceTargetData * dataPointer)
void	removeAllReferenceOwners ()

Detailed Description#

The class SBGRenderNode is the base class to describe a node in SAMSON's render graph. The render graph contains information to render data graph nodes in SAMSON's data graph.

Short name: SBRenderNode

Public Types Documentation#

enum Type#

enum SBGRenderNode::Type {
    Undefined = 0,
    DocumentManager = 1,
    Document = 2,
    Folder = 3,
    Controller = 4,
    Label = 5,
    Presentation = 6,
    Light = 7,
    StructuralModel = 31,
    VisualModel = 32,
    Mesh = 320,
    DynamicalModel = 33,
    InteractionModel = 34,
    PropertyModel = 35,
    Simulator = 36,
    StateUpdater = 37
};

Public Functions Documentation#

function display#

Display the node.

virtual void SBGRenderNode::display (
    SBNode::RenderingPass renderingPass
) = 0

function forEachNodeDepthFirst [1/2]#

virtual void SBGRenderNode::forEachNodeDepthFirst (
    void(*)( SBGRenderNode *node) action
)

function forEachNodeDepthFirst [2/2]#

virtual void SBGRenderNode::forEachNodeDepthFirst (
    SBCClass * object,
    void(SBCClass::*)( SBGRenderNode *node) action
)

function getNodes [1/4]#

virtual void SBGRenderNode::getNodes (
    std::vector< SBGRenderNode * > & selection
)

function getNodes [2/4]#

virtual void SBGRenderNode::getNodes (
    std::vector< SBGRenderNode * > & selection,
    SBGRenderNode::Type type
)

function getNodes [3/4]#

virtual void SBGRenderNode::getNodes (
    std::vector< SBGRenderNode * > & selection,
    bool(*)( SBGRenderNode *) selectionRule
)

function getNodes [4/4]#

virtual void SBGRenderNode::getNodes (
    std::vector< SBGRenderNode * > & selection,
    bool(*)( SBGRenderNode *) visitRule,
    bool(*)( SBGRenderNode *) selectionRule
)

function getParent#

Return parent of the render node.

virtual SBGRenderNode * SBGRenderNode::getParent () const

function getType#

Return type of the render node.

virtual Type SBGRenderNode::getType () const

function print#

Print debug information.

virtual void SBGRenderNode::print (
    unsigned int offset=0
) const

function requestViewportUpdate#

Request a viewport update.

virtual void SBGRenderNode::requestViewportUpdate ()

Public Static Functions Documentation#

function forEachNodeInSelection [1/2]#

static void SBGRenderNode::forEachNodeInSelection (
    std::vector< SBGRenderNode * > & selection,
    void(*)( SBGRenderNode *node) action
)

function forEachNodeInSelection [2/2]#

static void SBGRenderNode::forEachNodeInSelection (
    std::vector< SBGRenderNode * > & selection,
    SBCClass * object,
    void(SBCClass::*)( SBGRenderNode *node) action
)

function getTypeString#

Return string representation of the type of the render node.

static std::string SBGRenderNode::getTypeString (
    Type type
)

Protected Functions Documentation#

function SBGRenderNode#

Build a base object.

SBGRenderNode::SBGRenderNode ()

function ~SBGRenderNode#

virtual SBGRenderNode::~SBGRenderNode ()