Visualization Library v1.0.3

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Protected Member Functions | Protected Attributes

vl::SceneManagerPortals Class Reference

The SceneManagerPortals calss implements a portal-based hidden surface removal algorithm to efficently render highly occluded scenes. More...

#include <SceneManagerPortals.hpp>

Inheritance diagram for vl::SceneManagerPortals:
vl::SceneManager vl::Object

List of all members.

Public Member Functions

 SceneManagerPortals ()
 Constructor.
void extractActors (ActorCollection &list)
 Appends to the given list all the Actor[s] contained in the scene regardless of their visibility.
void extractVisibleActors (ActorCollection &list, const Camera *camera)
 Appends to the given list all the visible Actor[s] using the portal culling algorithm.
std::vector< ref< Sector > > & sectors ()
 The Sectors that are part of the scene.
const std::vector< ref< Sector > > & sectors () const
 The Sectors that are part of the scene.
SectorexternalSector ()
 Returns the external sector.
const SectorexternalSector () const
 Returns the external sector.
void computePortalNormals ()
 Compute the normal of the sectors.
void initialize ()
 Calls computePortalNormals() and performs some error checking.
bool showPortals () const
 Whether portals should be shown in the rendering or not.
void setShowPortals (bool show)
 Whether portals should be shown in the rendering or not.
void invalidatePortalActors ()
 Regenerates the portal actors next time their rendering is requested.
const std::vector< Frustum > & frustumStack () const
 The stack of frustums active at a given point during sector discovery.

Protected Member Functions

void renderPortal (Portal *portal)
void visitSector (Sector *prev, Sector *sector, const vec3 &eye, const Camera *camera)
SectorcomputeStartingSector (const Camera *camera)

Protected Attributes

ref< SectormExternalSector
std::vector< ref< Sector > > mSectors
std::vector< ref< Actor > > mTempActors
std::map< Portal *, ref< Actor > > mPortalActorMap
std::vector< FrustummFrustumStack
unsigned mVisitTick
bool mShowPortals

Detailed Description

The SceneManagerPortals calss implements a portal-based hidden surface removal algorithm to efficently render highly occluded scenes.

See also:

Definition at line 184 of file SceneManagerPortals.hpp.


Constructor & Destructor Documentation

vl::SceneManagerPortals::SceneManagerPortals (  ) [inline]

Constructor.

Definition at line 190 of file SceneManagerPortals.hpp.

References VL_DEBUG_SET_OBJECT_NAME.


Member Function Documentation

void SceneManagerPortals::extractActors ( ActorCollection list ) [virtual]

Appends to the given list all the Actor[s] contained in the scene regardless of their visibility.

Implements vl::SceneManager.

Definition at line 129 of file SceneManagerPortals.cpp.

References mSectors, and vl::Collection< T >::push_back().

Referenced by extractVisibleActors().

void SceneManagerPortals::extractVisibleActors ( ActorCollection list,
const Camera camera 
) [virtual]
std::vector< ref<Sector> >& vl::SceneManagerPortals::sectors (  ) [inline]

The Sectors that are part of the scene.

Definition at line 201 of file SceneManagerPortals.hpp.

Referenced by computeStartingSector().

const std::vector< ref<Sector> >& vl::SceneManagerPortals::sectors (  ) const [inline]

The Sectors that are part of the scene.

Definition at line 203 of file SceneManagerPortals.hpp.

Sector* vl::SceneManagerPortals::externalSector (  ) [inline]

Returns the external sector.

The external sector is a special sector that is considered visible when the camera is not inside any other sector. The external sector can be used to contain objects that are outside the indoor environment defined by the other "normal" sectors. For example, you could use the SceneManagerPortals to model a house and put in the external sector all the objects that are outside the house. The portals inside the house can point to the external sector so that the objects outside the house are rendered only if they are visible through a door or a window for maximum performances. Of course you can also go from an external sector to an internal sector just as well using one or more portals.

Definition at line 212 of file SceneManagerPortals.hpp.

Referenced by computeStartingSector().

const Sector* vl::SceneManagerPortals::externalSector (  ) const [inline]

Returns the external sector.

Definition at line 214 of file SceneManagerPortals.hpp.

void SceneManagerPortals::computePortalNormals (  )

Compute the normal of the sectors.

Definition at line 229 of file SceneManagerPortals.cpp.

References mSectors.

Referenced by initialize().

void SceneManagerPortals::initialize (  )

Calls computePortalNormals() and performs some error checking.

Definition at line 85 of file SceneManagerPortals.cpp.

References computePortalNormals(), vl::Log::error(), and mSectors.

bool vl::SceneManagerPortals::showPortals (  ) const [inline]

Whether portals should be shown in the rendering or not.

Definition at line 223 of file SceneManagerPortals.hpp.

Referenced by visitSector().

void vl::SceneManagerPortals::setShowPortals ( bool  show ) [inline]

Whether portals should be shown in the rendering or not.

Definition at line 225 of file SceneManagerPortals.hpp.

void vl::SceneManagerPortals::invalidatePortalActors (  ) [inline]

Regenerates the portal actors next time their rendering is requested.

Definition at line 227 of file SceneManagerPortals.hpp.

const std::vector<Frustum>& vl::SceneManagerPortals::frustumStack (  ) const [inline]

The stack of frustums active at a given point during sector discovery.

Definition at line 230 of file SceneManagerPortals.hpp.

void SceneManagerPortals::renderPortal ( Portal portal ) [protected]
void SceneManagerPortals::visitSector ( Sector prev,
Sector sector,
const vec3 eye,
const Camera camera 
) [protected]
Sector * SceneManagerPortals::computeStartingSector ( const Camera camera ) [protected]

Member Data Documentation

Definition at line 238 of file SceneManagerPortals.hpp.

std::vector< ref<Sector> > vl::SceneManagerPortals::mSectors [protected]
std::vector< ref<Actor> > vl::SceneManagerPortals::mTempActors [protected]

Definition at line 240 of file SceneManagerPortals.hpp.

Referenced by extractVisibleActors(), renderPortal(), and visitSector().

Definition at line 241 of file SceneManagerPortals.hpp.

Referenced by renderPortal().

Definition at line 242 of file SceneManagerPortals.hpp.

Referenced by extractVisibleActors(), and visitSector().

Definition at line 243 of file SceneManagerPortals.hpp.

Referenced by extractVisibleActors(), and visitSector().

Definition at line 244 of file SceneManagerPortals.hpp.


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

Visualization Library v1.0.3 Reference Documentation
Copyright Michele Bosi. All rights reserved.
Updated on Tue Feb 7 2017 00:55:11.
Permission is granted to use this page to write and publish articles regarding Visualization Library.