OGRE  1.12.8
Object-Oriented Graphics Rendering Engine
Ogre::DefaultZone Class Reference

#include <OgreDefaultZone.h>

+ Inheritance diagram for Ogre::DefaultZone:

Public Member Functions

 DefaultZone (PCZSceneManager *, const String &)
 
 ~DefaultZone ()
 
void _addNode (PCZSceneNode *)
 Adds an SceneNode to this Zone. More...
 
void _checkLightAgainstPortals (PCZLight *, unsigned long, PCZFrustum *, Portal *)
 (recursive) check the given light against all portals in the zone More...
 
void _checkNodeAgainstPortals (PCZSceneNode *, Portal *)
 (recursive) check the given node against all portals in the zone More...
 
void _findNodes (const AxisAlignedBox &t, PCZSceneNodeList &list, PortalList &visitedPortals, bool includeVisitors, bool recurseThruPortals, PCZSceneNode *exclude)
 
void _findNodes (const PlaneBoundedVolume &t, PCZSceneNodeList &list, PortalList &visitedPortals, bool includeVisitors, bool recurseThruPortals, PCZSceneNode *exclude)
 
void _findNodes (const Ray &t, PCZSceneNodeList &list, PortalList &visitedPortals, bool includeVisitors, bool recurseThruPortals, PCZSceneNode *exclude)
 
void _findNodes (const Sphere &t, PCZSceneNodeList &list, PortalList &visitedPortals, bool includeVisitors, bool recurseThruPortals, PCZSceneNode *exclude)
 
void dirtyNodeByMovingPortals (void)
 Mark nodes dirty base on moving portals. More...
 
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 notifyBeginRenderScene (void)
 Called when a _renderScene is called in the SceneManager. More...
 
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 removeNode (PCZSceneNode *)
 Removes all references to a SceneNode from this Zone. More...
 
bool requiresZoneSpecificNodeData (void)
 Indicates whether or not this zone requires zone-specific data for each scene node. More...
 
void setEnclosureNode (PCZSceneNode *)
 Set the enclosure node for this Zone. More...
 
bool setOption (const String &, const void *)
 Sets the options for the Zone. More...
 
virtual void setZoneGeometry (const String &filename, PCZSceneNode *parentNode)
 Called by PCZSM during setZoneGeometry() More...
 
PCZoneupdateNodeHomeZone (PCZSceneNode *pczsn, bool allowBackTouces)
 Update a node's home zone. More...
 
void updatePortalsZoneData (void)
 Update the zone data for each portal. More...
 
- Public Member Functions inherited from Ogre::PCZone
 PCZone (PCZSceneManager *, const String &)
 
virtual ~PCZone ()
 
virtual void _addAntiPortal (AntiPortal *newAntiPortal)
 Add an anti portal to the zone. More...
 
virtual void _addPortal (Portal *newPortal)
 Add a portal to the zone. More...
 
virtual void _clearNodeLists (short nodeListTypes)
 Remove all nodes from the node reference list and clear it. More...
 
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...
 
virtual void createNodeZoneData (PCZSceneNode *)
 Create zone specific data for a node. More...
 
virtual PortalfindMatchingPortal (Portal *)
 Find a matching portal (for connecting portals) 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 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...
 
void setPortalsUpdated (bool updated)
 
void setUserData (void *userData)
 

Additional Inherited Members

- Public Types inherited from Ogre::PCZone
enum  NODE_LIST_TYPE { HOME_NODE_LIST = 1, VISITOR_NODE_LIST = 2 }
 
- Public Attributes inherited from Ogre::PCZone
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...
 

Constructor & Destructor Documentation

◆ DefaultZone()

Ogre::DefaultZone::DefaultZone ( PCZSceneManager ,
const String  
)

◆ ~DefaultZone()

Ogre::DefaultZone::~DefaultZone ( )

Member Function Documentation

◆ setEnclosureNode()

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

Set the enclosure node for this Zone.

Implements Ogre::PCZone.

◆ _addNode()

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

Adds an SceneNode to this Zone.

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

Implements Ogre::PCZone.

◆ removeNode()

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

Removes all references to a SceneNode from this Zone.

Implements Ogre::PCZone.

◆ requiresZoneSpecificNodeData()

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

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

Implements Ogre::PCZone.

◆ _checkNodeAgainstPortals()

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

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

Implements Ogre::PCZone.

◆ _checkLightAgainstPortals()

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

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

Implements Ogre::PCZone.

◆ updatePortalsZoneData()

void Ogre::DefaultZone::updatePortalsZoneData ( void  )
virtual

Update the zone data for each portal.

Implements Ogre::PCZone.

◆ dirtyNodeByMovingPortals()

void Ogre::DefaultZone::dirtyNodeByMovingPortals ( void  )
virtual

Mark nodes dirty base on moving portals.

Implements Ogre::PCZone.

◆ updateNodeHomeZone()

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

Update a node's home zone.

Implements Ogre::PCZone.

◆ findVisibleNodes()

void Ogre::DefaultZone::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.

◆ _findNodes() [1/4]

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

Implements Ogre::PCZone.

◆ _findNodes() [2/4]

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

Implements Ogre::PCZone.

◆ _findNodes() [3/4]

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

Implements Ogre::PCZone.

◆ _findNodes() [4/4]

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

Implements Ogre::PCZone.

◆ setOption()

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

Sets the options for the Zone.

Implements Ogre::PCZone.

◆ notifyCameraCreated()

void Ogre::DefaultZone::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.

◆ notifyWorldGeometryRenderQueue()

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

Called by PCZSM during setWorldGeometryRenderQueue()

Implements Ogre::PCZone.

◆ notifyBeginRenderScene()

virtual void Ogre::DefaultZone::notifyBeginRenderScene ( void  )
virtual

Called when a _renderScene is called in the SceneManager.

Implements Ogre::PCZone.

◆ setZoneGeometry()

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

Called by PCZSM during setZoneGeometry()

Implements Ogre::PCZone.


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