OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::OctreeZone Class Reference

#include <OgreOctreeZone.h>

+ Inheritance diagram for Ogre::OctreeZone:
+ Collaboration diagram for Ogre::OctreeZone:

Public Types

enum  NODE_LIST_TYPE { HOME_NODE_LIST = 1, VISITOR_NODE_LIST = 2 }
 

Public Member Functions

 OctreeZone (PCZSceneManager *, const String &)
 
virtual ~OctreeZone ()
 
virtual void _addAntiPortal (AntiPortal *newAntiPortal)
 Add an anti portal to the zone. More...
 
virtual void _addNode (PCZSceneNode *)
 Adds an SceneNode to this OctreeZone. More...
 
virtual void _addPortal (Portal *newPortal)
 Add a portal to the zone. More...
 
virtual void _checkLightAgainstPortals (PCZLight *, unsigned long, PCZFrustum *, Portal *)
 (recursive) Check the given light against all portals in the zone More...
 
virtual void _checkNodeAgainstPortals (PCZSceneNode *, Portal *)
 (recursive) Check the given node against all portals in the zone More...
 
virtual void _clearNodeLists (short nodeListTypes)
 Remove all nodes from the node reference list and clear it. More...
 
virtual void _findNodes (const AxisAlignedBox &t, PCZSceneNodeList &list, PortalList &visitedPortals, bool includeVisitors, bool recurseThruPortals, PCZSceneNode *exclude)
 Functions for finding Nodes that intersect various shapes. More...
 
virtual void _findNodes (const Sphere &t, PCZSceneNodeList &list, PortalList &visitedPortals, bool includeVisitors, bool recurseThruPortals, PCZSceneNode *exclude)
 
virtual void _findNodes (const PlaneBoundedVolume &t, PCZSceneNodeList &list, PortalList &visitedPortals, bool includeVisitors, bool recurseThruPortals, PCZSceneNode *exclude)
 
virtual void _findNodes (const Ray &t, PCZSceneNodeList &list, PortalList &visitedPortals, bool includeVisitors, bool recurseThruPortals, PCZSceneNode *exclude)
 
virtual void _removeAntiPortal (AntiPortal *removeAntiPortal)
 Remove an anti portal from the zone. More...
 
virtual void _removePortal (Portal *removePortal)
 Remove a portal from the zone. More...
 
void addNodeToOctree (PCZSceneNode *, Octree *octree, int depth=0)
 Adds the Octree Node, starting at the given octree, and recursing at max to the specified depth. More...
 
virtual void createNodeZoneData (PCZSceneNode *)
 Create zone specific data for a node. More...
 
void dirtyNodeByMovingPortals (void)
 Mark nodes dirty base on moving portals. More...
 
virtual PortalfindMatchingPortal (Portal *)
 Find a matching portal (for connecting portals) More...
 
virtual void findVisibleNodes (PCZCamera *, NodeList &visibleNodeList, RenderQueue *queue, VisibleObjectsBoundsInfo *visibleBounds, bool onlyShadowCasters, bool displayNodes, bool showBoundingBoxes)
 Find and add visible objects to the render queue. More...
 
virtual void getAABB (AxisAlignedBox &)
 Get the world coordinate aabb of the zone. More...
 
SceneNodegetEnclosureNode (void)
 Get a pointer to the enclosure node for this PCZone. More...
 
unsigned long getLastVisibleFrame (void)
 Get the lastVisibleFrame counter value. More...
 
PCZCameragetLastVisibleFromCamera ()
 Get the lastVisibleFromCamera pointer. More...
 
const StringgetName (void) const
 
bool getPortalsUpdated (void)
 
void * getUserData (void)
 Get & set the user data. More...
 
const StringgetZoneTypeName () const
 
bool hasSky (void)
 
void init (AxisAlignedBox &box, int depth)
 Init function carried over from OctreeSceneManager. More...
 
virtual void notifyBeginRenderScene (void)
 Called when a _renderScene is called in the SceneManager. More...
 
virtual void notifyCameraCreated (Camera *c)
 Called when the scene manager creates a camera because some zone managers (like TerrainZone) need the camera info. More...
 
virtual void notifyWorldGeometryRenderQueue (uint8 qid)
 Called by PCZSM during setWorldGeometryRenderQueue() More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
virtual void removeNode (PCZSceneNode *)
 Removes all references to a SceneNode from this Zone. More...
 
void removeNodeFromOctree (PCZSceneNode *)
 Removes the node from the octree it is in. More...
 
virtual bool requiresZoneSpecificNodeData (void)
 Indicates whether or not this zone requires zone-specific data for each scene node. More...
 
void resize (const AxisAlignedBox &box)
 Resizes the octree to the given size. More...
 
virtual void setEnclosureNode (PCZSceneNode *)
 Set the enclosure node for this OctreeZone. More...
 
void setHasSky (bool yesno)
 If sky should be drawn with this zone. More...
 
void setLastVisibleFrame (unsigned long frameCount)
 Set the lastVisibleFrame counter. More...
 
void setLastVisibleFromCamera (PCZCamera *camera)
 Set the lastVisibleFromCamera pointer. More...
 
virtual bool setOption (const String &, const void *)
 Sets the given option for the Zone. More...
 
void setPortalsUpdated (bool updated)
 
void setUserData (void *userData)
 
virtual void setZoneGeometry (const String &filename, PCZSceneNode *parentNode)
 Called by PCZSM during setZoneGeometry() More...
 
virtual PCZoneupdateNodeHomeZone (PCZSceneNode *pczsn, bool allowBackTouces)
 Update a node's home zone. More...
 
void updateNodeOctant (OctreeZoneData *zoneData)
 Checks the given OctreeNode, and determines if it needs to be moved to a different octant. More...
 
void updatePortalsZoneData (void)
 Update the zone data for each portal. More...
 

Public Attributes

AntiPortalList mAntiPortals
 
PCZSceneManagermPCZSM
 Pointer to the pcz scene manager that created this zone. More...
 
PortalList mPortals
 List of Portals which this zone contains (each portal leads to another zone) More...
 

Protected Member Functions

void walkOctree (PCZCamera *, NodeList &, RenderQueue *, Octree *, VisibleObjectsBoundsInfo *visibleBounds, bool foundvisible, bool onlyShadowCasters, bool displayNodes, bool showBoundingBoxes)
 Walks through the octree, adding any visible objects to the render queue. More...
 

Protected Attributes

AxisAlignedBox mBox
 Size of the octree. More...
 
SceneNodemEnclosureNode
 SceneNode which corresponds to the enclosure for this zone. More...
 
bool mHasSky
 Flag determining whether or not this zone has sky in it. More...
 
PCZSceneNodeList mHomeNodeList
 List of SceneNodes contained in this particular PCZone. More...
 
unsigned long mLastVisibleFrame
 Frame counter for visibility. More...
 
PCZCameramLastVisibleFromCamera
 Last camera which this zone was visible to. More...
 
int mMaxDepth
 Max depth for the tree. More...
 
String mName
 Name of the zone (must be unique) More...
 
OctreemOctree
 The root octree. More...
 
bool mPortalsUpdated
 Flag recording whether any portals in this zone have moved. More...
 
void * mUserData
 User defined data pointer - NOT allocated or deallocated by the zone! you must clean it up yourself! More...
 
PCZSceneNodeList mVisitorNodeList
 List of SceneNodes visiting this particular PCZone. More...
 
String mZoneTypeName
 Zone type name. More...
 

Detailed Description

Definition at line 53 of file OgreOctreeZone.h.

Member Enumeration Documentation

Enumerator
HOME_NODE_LIST 
VISITOR_NODE_LIST 

Definition at line 85 of file OgrePCZone.h.

Constructor & Destructor Documentation

Ogre::OctreeZone::OctreeZone ( PCZSceneManager ,
const String  
)
virtual Ogre::OctreeZone::~OctreeZone ( )
virtual

Member Function Documentation

virtual void Ogre::PCZone::_addAntiPortal ( AntiPortal newAntiPortal)
virtualinherited

Add an anti portal to the zone.

virtual void Ogre::OctreeZone::_addNode ( PCZSceneNode )
virtual

Adds an SceneNode to this OctreeZone.

Remarks
The PCZSceneManager calls this function to add a node to the zone.

Implements Ogre::PCZone.

virtual void Ogre::PCZone::_addPortal ( Portal newPortal)
virtualinherited

Add a portal to the zone.

virtual void Ogre::OctreeZone::_checkLightAgainstPortals ( PCZLight ,
unsigned  long,
PCZFrustum ,
Portal  
)
virtual

(recursive) Check the given light against all portals in the zone

Implements Ogre::PCZone.

virtual void Ogre::OctreeZone::_checkNodeAgainstPortals ( PCZSceneNode ,
Portal  
)
virtual

(recursive) Check the given node against all portals in the zone

Implements Ogre::PCZone.

virtual void Ogre::OctreeZone::_clearNodeLists ( short  nodeListTypes)
virtual

Remove all nodes from the node reference list and clear it.

Reimplemented from Ogre::PCZone.

virtual void Ogre::OctreeZone::_findNodes ( const AxisAlignedBox t,
PCZSceneNodeList list,
PortalList visitedPortals,
bool  includeVisitors,
bool  recurseThruPortals,
PCZSceneNode exclude 
)
virtual

Functions for finding Nodes that intersect various shapes.

Implements Ogre::PCZone.

virtual void Ogre::OctreeZone::_findNodes ( const Sphere t,
PCZSceneNodeList list,
PortalList visitedPortals,
bool  includeVisitors,
bool  recurseThruPortals,
PCZSceneNode exclude 
)
virtual

Implements Ogre::PCZone.

virtual void Ogre::OctreeZone::_findNodes ( const PlaneBoundedVolume t,
PCZSceneNodeList list,
PortalList visitedPortals,
bool  includeVisitors,
bool  recurseThruPortals,
PCZSceneNode exclude 
)
virtual

Implements Ogre::PCZone.

virtual void Ogre::OctreeZone::_findNodes ( const Ray t,
PCZSceneNodeList list,
PortalList visitedPortals,
bool  includeVisitors,
bool  recurseThruPortals,
PCZSceneNode exclude 
)
virtual

Implements Ogre::PCZone.

virtual void Ogre::PCZone::_removeAntiPortal ( AntiPortal removeAntiPortal)
virtualinherited

Remove an anti portal from the zone.

virtual void Ogre::PCZone::_removePortal ( Portal removePortal)
virtualinherited

Remove a portal from the zone.

void Ogre::OctreeZone::addNodeToOctree ( PCZSceneNode ,
Octree octree,
int  depth = 0 
)

Adds the Octree Node, starting at the given octree, and recursing at max to the specified depth.

virtual void Ogre::OctreeZone::createNodeZoneData ( PCZSceneNode )
virtual

Create zone specific data for a node.

Reimplemented from Ogre::PCZone.

void Ogre::OctreeZone::dirtyNodeByMovingPortals ( void  )
virtual

Mark nodes dirty base on moving portals.

Implements Ogre::PCZone.

virtual Portal* Ogre::PCZone::findMatchingPortal ( Portal )
virtualinherited

Find a matching portal (for connecting portals)

virtual void Ogre::OctreeZone::findVisibleNodes ( PCZCamera ,
NodeList visibleNodeList,
RenderQueue queue,
VisibleObjectsBoundsInfo *  visibleBounds,
bool  onlyShadowCasters,
bool  displayNodes,
bool  showBoundingBoxes 
)
virtual

Find and add visible objects to the render queue.

Remarks
Starts with objects in the zone and proceeds through visible portals This is a recursive call (the main call should be to _findVisibleObjects)

Implements Ogre::PCZone.

virtual void Ogre::OctreeZone::getAABB ( AxisAlignedBox )
virtual

Get the world coordinate aabb of the zone.

Reimplemented from Ogre::PCZone.

SceneNode* Ogre::PCZone::getEnclosureNode ( void  )
inlineinherited

Get a pointer to the enclosure node for this PCZone.

Definition at line 102 of file OgrePCZone.h.

unsigned long Ogre::PCZone::getLastVisibleFrame ( void  )
inlineinherited

Get the lastVisibleFrame counter value.

Definition at line 116 of file OgrePCZone.h.

PCZCamera* Ogre::PCZone::getLastVisibleFromCamera ( )
inlineinherited

Get the lastVisibleFromCamera pointer.

Definition at line 122 of file OgrePCZone.h.

const String& Ogre::PCZone::getName ( void  ) const
inlineinherited
Returns
the name of the zone

Definition at line 98 of file OgrePCZone.h.

bool Ogre::PCZone::getPortalsUpdated ( void  )
inlineinherited

Definition at line 244 of file OgrePCZone.h.

void* Ogre::PCZone::getUserData ( void  )
inlineinherited

Get & set the user data.

Definition at line 246 of file OgrePCZone.h.

const String& Ogre::PCZone::getZoneTypeName ( ) const
inlineinherited
Returns
The zone type name (ex: "ZoneType_Terrain")

Definition at line 95 of file OgrePCZone.h.

bool Ogre::PCZone::hasSky ( void  )
inlineinherited
Returns
Whether or not this zone has sky

Definition at line 110 of file OgrePCZone.h.

void Ogre::OctreeZone::init ( AxisAlignedBox box,
int  depth 
)

Init function carried over from OctreeSceneManager.

virtual void Ogre::OctreeZone::notifyBeginRenderScene ( void  )
virtual

Called when a _renderScene is called in the SceneManager.

Implements Ogre::PCZone.

virtual void Ogre::OctreeZone::notifyCameraCreated ( Camera c)
virtual

Called when the scene manager creates a camera because some zone managers (like TerrainZone) need the camera info.

Implements Ogre::PCZone.

virtual void Ogre::OctreeZone::notifyWorldGeometryRenderQueue ( uint8  qid)
virtual

Called by PCZSM during setWorldGeometryRenderQueue()

Implements Ogre::PCZone.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::OctreeZone::removeNode ( PCZSceneNode )
virtual

Removes all references to a SceneNode from this Zone.

Implements Ogre::PCZone.

void Ogre::OctreeZone::removeNodeFromOctree ( PCZSceneNode )

Removes the node from the octree it is in.

virtual bool Ogre::OctreeZone::requiresZoneSpecificNodeData ( void  )
virtual

Indicates whether or not this zone requires zone-specific data for each scene node.

Implements Ogre::PCZone.

void Ogre::OctreeZone::resize ( const AxisAlignedBox box)

Resizes the octree to the given size.

virtual void Ogre::OctreeZone::setEnclosureNode ( PCZSceneNode )
virtual

Set the enclosure node for this OctreeZone.

Implements Ogre::PCZone.

void Ogre::PCZone::setHasSky ( bool  yesno)
inlineinherited

If sky should be drawn with this zone.

Definition at line 106 of file OgrePCZone.h.

void Ogre::PCZone::setLastVisibleFrame ( unsigned long  frameCount)
inlineinherited

Set the lastVisibleFrame counter.

Definition at line 113 of file OgrePCZone.h.

void Ogre::PCZone::setLastVisibleFromCamera ( PCZCamera camera)
inlineinherited

Set the lastVisibleFromCamera pointer.

Definition at line 119 of file OgrePCZone.h.

virtual bool Ogre::OctreeZone::setOption ( const String ,
const void *   
)
virtual

Sets the given option for the Zone.

Remarks
Options are: "Size", AxisAlignedBox *; "Depth", int *; "ShowOctree", bool *;

Implements Ogre::PCZone.

void Ogre::PCZone::setPortalsUpdated ( bool  updated)
inlineinherited

Definition at line 243 of file OgrePCZone.h.

void Ogre::PCZone::setUserData ( void *  userData)
inlineinherited

Definition at line 247 of file OgrePCZone.h.

virtual void Ogre::OctreeZone::setZoneGeometry ( const String filename,
PCZSceneNode parentNode 
)
virtual

Called by PCZSM during setZoneGeometry()

Implements Ogre::PCZone.

virtual PCZone* Ogre::OctreeZone::updateNodeHomeZone ( PCZSceneNode pczsn,
bool  allowBackTouces 
)
virtual

Update a node's home zone.

Implements Ogre::PCZone.

void Ogre::OctreeZone::updateNodeOctant ( OctreeZoneData zoneData)

Checks the given OctreeNode, and determines if it needs to be moved to a different octant.

void Ogre::OctreeZone::updatePortalsZoneData ( void  )
virtual

Update the zone data for each portal.

Implements Ogre::PCZone.

void Ogre::OctreeZone::walkOctree ( PCZCamera ,
NodeList ,
RenderQueue ,
Octree ,
VisibleObjectsBoundsInfo *  visibleBounds,
bool  foundvisible,
bool  onlyShadowCasters,
bool  displayNodes,
bool  showBoundingBoxes 
)
protected

Walks through the octree, adding any visible objects to the render queue.

Remarks
If any octant in the octree if completely within the view frustum, all subchildren are automatically added with no visibility tests.

Member Data Documentation

AntiPortalList Ogre::PCZone::mAntiPortals
inherited

Definition at line 251 of file OgrePCZone.h.

AxisAlignedBox Ogre::OctreeZone::mBox
protected

Size of the octree.

Definition at line 210 of file OgreOctreeZone.h.

SceneNode* Ogre::PCZone::mEnclosureNode
protectedinherited

SceneNode which corresponds to the enclosure for this zone.

Definition at line 282 of file OgrePCZone.h.

bool Ogre::PCZone::mHasSky
protectedinherited

Flag determining whether or not this zone has sky in it.

Definition at line 280 of file OgrePCZone.h.

PCZSceneNodeList Ogre::PCZone::mHomeNodeList
protectedinherited

List of SceneNodes contained in this particular PCZone.

Definition at line 284 of file OgrePCZone.h.

unsigned long Ogre::PCZone::mLastVisibleFrame
protectedinherited

Frame counter for visibility.

Definition at line 276 of file OgrePCZone.h.

PCZCamera* Ogre::PCZone::mLastVisibleFromCamera
protectedinherited

Last camera which this zone was visible to.

Definition at line 278 of file OgrePCZone.h.

int Ogre::OctreeZone::mMaxDepth
protected

Max depth for the tree.

Definition at line 208 of file OgreOctreeZone.h.

String Ogre::PCZone::mName
protectedinherited

Name of the zone (must be unique)

Definition at line 272 of file OgrePCZone.h.

Octree* Ogre::OctreeZone::mOctree
protected

The root octree.

Definition at line 206 of file OgreOctreeZone.h.

PCZSceneManager* Ogre::PCZone::mPCZSM
inherited

Pointer to the pcz scene manager that created this zone.

Definition at line 253 of file OgrePCZone.h.

PortalList Ogre::PCZone::mPortals
inherited

List of Portals which this zone contains (each portal leads to another zone)

Definition at line 250 of file OgrePCZone.h.

bool Ogre::PCZone::mPortalsUpdated
protectedinherited

Flag recording whether any portals in this zone have moved.

Definition at line 288 of file OgrePCZone.h.

void* Ogre::PCZone::mUserData
protectedinherited

User defined data pointer - NOT allocated or deallocated by the zone! you must clean it up yourself!

Definition at line 291 of file OgrePCZone.h.

PCZSceneNodeList Ogre::PCZone::mVisitorNodeList
protectedinherited

List of SceneNodes visiting this particular PCZone.

Definition at line 286 of file OgrePCZone.h.

String Ogre::PCZone::mZoneTypeName
protectedinherited

Zone type name.

Definition at line 274 of file OgrePCZone.h.


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