Public Member Functions | Protected Member Functions | Protected Attributes

sp::scene::RenderNode Class Reference

Interface for all renderable objects: visible 3d geometry and light sources or a whole scene graph. More...

#include <spRenderNode.hpp>

Inheritance diagram for sp::scene::RenderNode:
sp::scene::SceneNode sp::Node sp::BaseObject sp::scene::MaterialNode sp::scene::SceneGraph sp::scene::Billboard sp::scene::Mesh sp::scene::Terrain sp::scene::SceneGraphFamilyTree sp::scene::SceneGraphPortalBased sp::scene::SceneGraphSimple sp::scene::SceneGraphSimpleStream

List of all members.

Public Member Functions

virtual ~RenderNode ()
virtual void render ()=0
virtual bool compare (const RenderNode *Other) const
 This functions compares this and the specified render node for depth sorting.
virtual void updateTransformation ()
 Updates the objects transformation and sets the depth distance.
void setDepthDistance (f32 Distance)
 Sets the depth distance. This value is used for sorting the objects by its distance to the camera view.
f32 getDepthDistance () const
void setOrder (s32 Order)
 Sets the order for sorting (by default 0).
s32 getOrder () const

Protected Member Functions

 RenderNode (const ENodeTypes Type)

Protected Attributes

f32 DepthDistance_
s32 Order_

Detailed Description

Interface for all renderable objects: visible 3d geometry and light sources or a whole scene graph.

Constructor & Destructor Documentation

sp::scene::RenderNode::~RenderNode (  )  [virtual]
sp::scene::RenderNode::RenderNode ( const ENodeTypes  Type  )  [protected]

Member Function Documentation

bool sp::scene::RenderNode::compare ( const RenderNode *  Other  )  const [virtual]

This functions compares this and the specified render node for depth sorting.

f32 sp::scene::RenderNode::getDepthDistance (  )  const [inline]
s32 sp::scene::RenderNode::getOrder (  )  const [inline]
virtual void sp::scene::RenderNode::render (  )  [pure virtual]

Renders the object. In this case rendering does not only mean drawing a 3d mesh. It can also be a light source.

Returns:
True if the object has been rendered. Otherwise the object has been sorted out by frustum culling.

Implemented in sp::scene::MaterialNode, sp::scene::Billboard, sp::scene::SceneGraph, sp::scene::SceneGraphFamilyTree, sp::scene::SceneGraphPortalBased, sp::scene::SceneGraphSimple, sp::scene::SceneGraphSimpleStream, sp::scene::Mesh, and sp::scene::Terrain.

void sp::scene::RenderNode::setDepthDistance ( f32  Distance  )  [inline]

Sets the depth distance. This value is used for sorting the objects by its distance to the camera view.

void sp::scene::RenderNode::setOrder ( s32  Order  )  [inline]

Sets the order for sorting (by default 0).

void sp::scene::RenderNode::updateTransformation (  )  [virtual]

Updates the objects transformation and sets the depth distance.

Reimplemented from sp::scene::SceneNode.

Reimplemented in sp::scene::Billboard.

Member Data Documentation

f32 sp::scene::RenderNode::DepthDistance_ [protected]
s32 sp::scene::RenderNode::Order_ [protected]
The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Thu Apr 4 2013 23:22:56 for SoftPixel Engine by  doxygen 1.7.1