Public Member Functions

sp::scene::SceneGraphPortalBased Class Reference
[Scene Management]

#include <spSceneGraphPortalBased.hpp>

Inheritance diagram for sp::scene::SceneGraphPortalBased:
sp::scene::SceneGraph sp::scene::RenderNode sp::scene::SceneNode sp::Node sp::BaseObject

List of all members.

Public Member Functions

 SceneGraphPortalBased ()
 ~SceneGraphPortalBased ()
Sector * createSector (const scene::Transformation &Transform)
void deleteSector (Sector *SectorObj)
void clearSectors ()
Portal * createPortal (const scene::Transformation &Transform)
Portal * createPortal (const scene::Transformation &Transform, Sector *FrontSector, Sector *BackSector)
void deletePortal (Portal *PortalObj)
void clearPortals ()
void render ()
Sector * findSector (const dim::vector3df &Point) const
 Returns the sector where the specified point is inside.
void connectSectors (f32 DistanceTolerance=0.1f)
void insertRenderNodes ()
void releaseRenderNodes ()
const std::list< Sector * > & getSectorList () const
const std::list< Portal * > & getPortalList () const

Detailed Description

This is the class for portal-based scene graphs.

Since:
Version 3.2

Constructor & Destructor Documentation

sp::scene::SceneGraphPortalBased::SceneGraphPortalBased (  ) 
sp::scene::SceneGraphPortalBased::~SceneGraphPortalBased (  ) 

Member Function Documentation

void sp::scene::SceneGraphPortalBased::clearPortals (  ) 
void sp::scene::SceneGraphPortalBased::clearSectors (  ) 
void sp::scene::SceneGraphPortalBased::connectSectors ( f32  DistanceTolerance = 0.1f  ) 

Connects all sectors with their nearest portals.

Parameters:
[in] DistanceTolerance Specifies the distance tolerance to determine which portals are nearby the sectors.
See also:
Sector::isPortalNearby
Portal* sp::scene::SceneGraphPortalBased::createPortal ( const scene::Transformation &  Transform  ) 
Portal* sp::scene::SceneGraphPortalBased::createPortal ( const scene::Transformation &  Transform,
Sector *  FrontSector,
Sector *  BackSector 
)
Sector* sp::scene::SceneGraphPortalBased::createSector ( const scene::Transformation &  Transform  ) 
void sp::scene::SceneGraphPortalBased::deletePortal ( Portal *  PortalObj  ) 
void sp::scene::SceneGraphPortalBased::deleteSector ( Sector *  SectorObj  ) 
Sector* sp::scene::SceneGraphPortalBased::findSector ( const dim::vector3df &  Point  )  const

Returns the sector where the specified point is inside.

const std::list<Portal*>& sp::scene::SceneGraphPortalBased::getPortalList (  )  const [inline]
const std::list<Sector*>& sp::scene::SceneGraphPortalBased::getSectorList (  )  const [inline]
void sp::scene::SceneGraphPortalBased::insertRenderNodes (  ) 

Inserts all 'global' render nodes into the sectors. This is the opposite functionality of "releaseRenderNodes".

See also:
releaseRenderNodes
void sp::scene::SceneGraphPortalBased::releaseRenderNodes (  ) 

Releases all render nodes from the sectors and makes them 'global' again. This is the opposite functionality of "insertRenderNodes".

See also:
insertRenderNodes
void sp::scene::SceneGraphPortalBased::render (  )  [virtual]

Renders the whole scene without using a camera object. This is particular used when a scene manager is a child of another one.

Implements sp::scene::SceneGraph.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Thu Apr 4 2013 23:22:57 for SoftPixel Engine by  doxygen 1.7.1