Developer Documentation
ACG::SceneGraph::OSDTransformNode Class Reference

#include <ACG/Scenegraph/OSDTransformNode.hh>

Inheritance diagram for ACG::SceneGraph::OSDTransformNode:
ACG::SceneGraph::BaseNode

Public Member Functions

 OSDTransformNode (BaseNode *_parent=0, const std::string &_name="<OSDTransformNode>")
 default constructor More...
 
 ~OSDTransformNode ()
 destructor More...
 
 ACG_CLASSNAME (OSDTransformNode)
 static name of this class
 
void enter (GLState &_state, const DrawModes::DrawMode &_drawMode) override
 set up transformation used for drawing More...
 
void leave (GLState &_state, const DrawModes::DrawMode &_drawMode) override
 restore transformation used for drawing More...
 
void enterPick (GLState &_state, PickTarget _target, const DrawModes::DrawMode &_drawMode) override
 set up transformation used for picking More...
 
void leavePick (GLState &_state, PickTarget _target, const DrawModes::DrawMode &_drawMode) override
 restore transformation used for picking More...
 
void setCenter (double _x, double _y)
 set center of OSD More...
 
void setCenter (ACG::Vec2d _c)
 
ACG::Vec2d getCenter () const
 get center of OSD More...
 
- Public Member Functions inherited from ACG::SceneGraph::BaseNode
 BaseNode (BaseNode *_parent=0, std::string _name="<unknown>")
 Default constructor. More...
 
 BaseNode (BaseNode *_parent, BaseNode *_child, std::string _name="<unknown>")
 Put this node between _parent and _child. More...
 
virtual ~BaseNode ()
 Destructor. More...
 
void delete_subtree ()
 Delete the whole subtree of this node. More...
 
virtual const std::string & className () const =0
 Return class name (implemented by the ACG_CLASSNAME macro)
 
virtual DrawModes::DrawMode availableDrawModes () const
 
virtual void boundingBox (Vec3d &, Vec3d &)
 
virtual void enter (GLState &, const DrawModes::DrawMode &)
 
virtual void enter (IRenderer *, GLState &_state, const DrawModes::DrawMode &_drawMode)
 
virtual void draw (GLState &, const DrawModes::DrawMode &)
 Draw this node using the draw modes _drawMode. More...
 
virtual void getRenderObjects (IRenderer *_renderer, GLState &_state, const DrawModes::DrawMode &_drawMode, const Material *_mat)
 Deferred draw call with shader based renderer. More...
 
virtual void leave (GLState &, const DrawModes::DrawMode &)
 
virtual void leave (IRenderer *, GLState &_state, const DrawModes::DrawMode &_drawMode)
 
virtual void enterPick (GLState &_state, PickTarget _target, const DrawModes::DrawMode &_drawMode)
 
virtual void pick (GLState &, PickTarget)
 
virtual void leavePick (GLState &_state, PickTarget _target, const DrawModes::DrawMode &_drawMode)
 
void enablePicking (bool _enable)
 
bool pickingEnabled ()
 
virtual void mouseEvent (GLState &, QMouseEvent *)
 Handle mouse event (some interaction, e.g. modeling) More...
 
void setDirty (bool _dirty=true)
 mark node for redrawn More...
 
bool isDirty () const
 Check if node should be redrawn. More...
 
ChildIter childrenBegin ()
 Returns: begin-iterator of children. More...
 
ConstChildIter childrenBegin () const
 Same but cont. More...
 
ChildIter childrenEnd ()
 Returns: end-iterator of children. More...
 
ConstChildIter childrenEnd () const
 Same but const. More...
 
ChildRIter childrenRBegin ()
 Returns: reverse begin-iterator of children. More...
 
ConstChildRIter childrenRBegin () const
 Same but const. More...
 
ChildRIter childrenREnd ()
 Returns: reverse end-iterator of children. More...
 
ConstChildRIter childrenREnd () const
 Same but const. More...
 
void push_back (BaseNode *_node)
 Insert _node at the end of the list of children. More...
 
void remove (ChildIter _pos)
 
size_t nChildren () const
 number of children More...
 
ChildIter find (BaseNode *_node)
 
BaseNodefind (const std::string &_name)
 
BaseNodeparent ()
 Get the nodes parent node. More...
 
const BaseNodeparent () const
 Get the nodes parent node. More...
 
void set_parent (BaseNode *_parent)
 Set the parent of this node. More...
 
StatusMode status () const
 Get node's status. More...
 
void set_status (StatusMode _s)
 Set the status of this node. More...
 
void hide ()
 Hide Node: set status to HideNode. More...
 
void show ()
 Show node: set status to Active. More...
 
bool visible ()
 Is node visible (status == Active)? More...
 
bool hidden ()
 Is node not visible (status != Active)? More...
 
std::string name () const
 Returns: name of node (needs not be unique) More...
 
void name (const std::string &_name)
 rename a node More...
 
unsigned int id () const
 
DrawModes::DrawMode drawMode () const
 Return the own draw modes of this node. More...
 
void drawMode (DrawModes::DrawMode _drawMode)
 
unsigned int traverseMode () const
 Return how the node should be traversed. More...
 
void setTraverseMode (unsigned int _mode)
 Set traverse mode for node. More...
 
MultipassBitMask multipassStatus () const
 Get the current multipass settings for the nodes status functions. More...
 
void setMultipassStatus (const MultipassBitMask _passStatus)
 Set multipass settings for the nodes status functions. More...
 
void multipassStatusSetActive (const unsigned int _i, bool _active)
 Set multipass status to traverse in a specific pass. More...
 
bool multipassStatusActive (const unsigned int _i) const
 Get multipass status to traverse in a specific pass. More...
 
MultipassBitMask multipassNode () const
 Get the current multipass settings for the node. More...
 
void setMultipassNode (const MultipassBitMask _passNode)
 Set multipass settings for the node. More...
 
void multipassNodeSetActive (const unsigned int _i, bool _active)
 Set Node status to traverse in a specific pass. More...
 
bool multipassNodeActive (const unsigned int _i) const
 Get Node status to traverse in a specific pass. More...
 
void setRenderObjectShaders (const std::string &_vertexShaderFile, const std::string &_geometryShaderFile, const std::string &_fragmentShaderFile, bool _relativePaths=true, DrawModes::DrawModePrimitive _primitiveType=DrawModes::PRIMITIVE_POLYGON)
 Set custom shaders. More...
 
void setRenderObjectShaders (const std::string &_vertexShaderFile, const std::string &_tessControlShaderFile, const std::string &_tessEvalShaderFile, const std::string &_geometryShaderFile, const std::string &_fragmentShaderFile, bool _relativePaths=true, DrawModes::DrawModePrimitive _primitiveType=DrawModes::PRIMITIVE_POLYGON)
 Set custom shaders. More...
 
void setRenderObjectUniformPool (const GLSL::UniformPool *_pool)
 Set uniforms for shader based rendering. More...
 
const GLSL::UniformPoolgetRenderObjectUniformPool ()
 Get uniforms for shader based rendering. More...
 
void setRenderObjectTexture (int _samplerSlot, GLuint _texId, GLenum _texType=GL_TEXTURE_2D)
 Set textures for shader based rendering. More...
 
void setRenderObjectModifier (RenderObjectModifier *_modifier)
 Set modifier for render objects. More...
 
RenderObjectModifiergetRenderObjectModifier ()
 Get render-object modifier. More...
 
void applyRenderObjectSettings (DrawModes::DrawModePrimitive _primitive, RenderObject *_obj) const
 Set shaders, textures and uniforms as provided by user to a render-object. More...
 

Private Member Functions

void enterOSD (GLState &_state, const DrawModes::DrawMode &_drawMode)
 
void leaveOSD (GLState &_state, const DrawModes::DrawMode &_drawMode)
 

Private Attributes

ACG::Vec2d center_
 

Additional Inherited Members

- Public Types inherited from ACG::SceneGraph::BaseNode
enum  StatusMode { Active = 0x1 , HideNode = 0x2 , HideChildren = 0x4 , HideSubtree = 0x8 }
 Status modi. More...
 
enum  TraverseMode { NodeFirst = 0x1 , ChildrenFirst = 0x2 , SecondPass = 0x4 }
 Node traverse types. More...
 
typedef std::vector< BaseNode * >::const_iterator ConstChildIter
 allows to iterate over children More...
 
typedef std::vector< BaseNode * >::iterator ChildIter
 allows to iterate over children More...
 
typedef std::vector< BaseNode * >::const_reverse_iterator ConstChildRIter
 allows to reverse iterate over children More...
 
typedef std::vector< BaseNode * >::reverse_iterator ChildRIter
 allows to reverse iterate over children More...
 
enum  PASSES {
  NOPASS = 0 , ALLPASSES = 1 << 0 , PASS_1 = 1 << 1 , PASS_2 = 1 << 2 ,
  PASS_3 = 1 << 3 , PASS_4 = 1 << 4 , PASS_5 = 1 << 5 , PASS_6 = 1 << 6 ,
  PASS_7 = 1 << 7 , PASS_8 = 1 << 8
}
 This enum should be used to enable rendering of a node in different. More...
 
typedef unsigned int MultipassBitMask
 Multipass pass bit mask type. More...
 

Detailed Description

OSDTransformNode sets up a transformation used to render on screen display geometry.

Definition at line 78 of file OSDTransformNode.hh.

Constructor & Destructor Documentation

◆ OSDTransformNode()

ACG::SceneGraph::OSDTransformNode::OSDTransformNode ( BaseNode _parent = 0,
const std::string &  _name = "<OSDTransformNode>" 
)
inline

default constructor

Definition at line 83 of file OSDTransformNode.hh.

◆ ~OSDTransformNode()

ACG::SceneGraph::OSDTransformNode::~OSDTransformNode ( )
inline

destructor

Definition at line 86 of file OSDTransformNode.hh.

Member Function Documentation

◆ enter()

void ACG::SceneGraph::OSDTransformNode::enter ( GLState _state,
const DrawModes::DrawMode _drawMode 
)
inlineoverridevirtual

set up transformation used for drawing

Reimplemented from ACG::SceneGraph::BaseNode.

Definition at line 92 of file OSDTransformNode.hh.

◆ enterOSD()

void ACG::SceneGraph::OSDTransformNode::enterOSD ( GLState _state,
const DrawModes::DrawMode _drawMode 
)
private

Definition at line 67 of file OSDTransformNode.cc.

◆ enterPick()

void ACG::SceneGraph::OSDTransformNode::enterPick ( GLState _state,
PickTarget  _target,
const DrawModes::DrawMode _drawMode 
)
inlineoverridevirtual

set up transformation used for picking

Reimplemented from ACG::SceneGraph::BaseNode.

Definition at line 98 of file OSDTransformNode.hh.

◆ getCenter()

ACG::Vec2d ACG::SceneGraph::OSDTransformNode::getCenter ( ) const
inline

get center of OSD

Definition at line 108 of file OSDTransformNode.hh.

◆ leave()

void ACG::SceneGraph::OSDTransformNode::leave ( GLState _state,
const DrawModes::DrawMode _drawMode 
)
inlineoverridevirtual

restore transformation used for drawing

Reimplemented from ACG::SceneGraph::BaseNode.

Definition at line 95 of file OSDTransformNode.hh.

◆ leaveOSD()

void ACG::SceneGraph::OSDTransformNode::leaveOSD ( GLState _state,
const DrawModes::DrawMode _drawMode 
)
private

Definition at line 105 of file OSDTransformNode.cc.

◆ leavePick()

void ACG::SceneGraph::OSDTransformNode::leavePick ( GLState _state,
PickTarget  _target,
const DrawModes::DrawMode _drawMode 
)
inlineoverridevirtual

restore transformation used for picking

Reimplemented from ACG::SceneGraph::BaseNode.

Definition at line 101 of file OSDTransformNode.hh.

◆ setCenter() [1/2]

void ACG::SceneGraph::OSDTransformNode::setCenter ( ACG::Vec2d  _c)
inline

Definition at line 105 of file OSDTransformNode.hh.

◆ setCenter() [2/2]

void ACG::SceneGraph::OSDTransformNode::setCenter ( double  _x,
double  _y 
)
inline

set center of OSD

Definition at line 104 of file OSDTransformNode.hh.

Member Data Documentation

◆ center_

ACG::Vec2d ACG::SceneGraph::OSDTransformNode::center_
private

Definition at line 115 of file OSDTransformNode.hh.


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