OGRE 14.3
Object-Oriented Graphics Rendering Engine
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Ogre::DefaultZone Class Reference

#include <OgreDefaultZone.h>

+ Inheritance diagram for Ogre::DefaultZone:

Public Member Functions

 DefaultZone (PCZSceneManager *, const String &)
 
 ~DefaultZone ()
 
void _addNode (PCZSceneNode *) override
 Adds an SceneNode to this Zone.
 
void _checkLightAgainstPortals (PCZLight *, unsigned long, PCZFrustum *, Portal *) override
 (recursive) check the given light against all portals in the zone
 
void _checkNodeAgainstPortals (PCZSceneNode *, Portal *) override
 (recursive) check the given node against all portals in the zone
 
void _findNodes (const AxisAlignedBox &t, PCZSceneNodeList &list, PortalList &visitedPortals, bool includeVisitors, bool recurseThruPortals, PCZSceneNode *exclude) override
 
void _findNodes (const PlaneBoundedVolume &t, PCZSceneNodeList &list, PortalList &visitedPortals, bool includeVisitors, bool recurseThruPortals, PCZSceneNode *exclude) override
 
void _findNodes (const Ray &t, PCZSceneNodeList &list, PortalList &visitedPortals, bool includeVisitors, bool recurseThruPortals, PCZSceneNode *exclude) override
 
void _findNodes (const Sphere &t, PCZSceneNodeList &list, PortalList &visitedPortals, bool includeVisitors, bool recurseThruPortals, PCZSceneNode *exclude) override
 
void dirtyNodeByMovingPortals (void) override
 Mark nodes dirty base on moving portals.
 
void findVisibleNodes (PCZCamera *, NodeList &visibleNodeList, RenderQueue *queue, VisibleObjectsBoundsInfo *visibleBounds, bool onlyShadowCasters, bool displayNodes, bool showBoundingBoxes) override
 Find and add visible objects to the render queue.
 
void notifyBeginRenderScene (void) override
 Called when a _renderScene is called in the SceneManager.
 
void notifyCameraCreated (Camera *c) override
 called when the scene manager creates a camera because some zone managers (like TerrainZone) need the camera info.
 
void notifyWorldGeometryRenderQueue (uint8 qid) override
 Called by PCZSM during setWorldGeometryRenderQueue()
 
void removeNode (PCZSceneNode *) override
 Removes all references to a SceneNode from this Zone.
 
bool requiresZoneSpecificNodeData (void) override
 Indicates whether or not this zone requires zone-specific data for each scene node.
 
void setEnclosureNode (PCZSceneNode *) override
 Set the enclosure node for this Zone.
 
bool setOption (const String &, const void *) override
 Sets the options for the Zone.
 
void setZoneGeometry (const String &filename, PCZSceneNode *parentNode) override
 Called by PCZSM during setZoneGeometry()
 
PCZone * updateNodeHomeZone (PCZSceneNode *pczsn, bool allowBackTouces) override
 Update a node's home zone.
 
void updatePortalsZoneData (void) override
 Update the zone data for each portal.
 
- 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.
 
virtual void _addPortal (Portal *newPortal)
 Add a portal to the zone.
 
virtual void _clearNodeLists (short nodeListTypes)
 Remove all nodes from the node reference list and clear it.
 
virtual void _removeAntiPortal (AntiPortal *removeAntiPortal)
 Remove an anti portal from the zone.
 
virtual void _removePortal (Portal *removePortal)
 Remove a portal from the zone.
 
virtual void createNodeZoneData (PCZSceneNode *)
 Create zone specific data for a node.
 
virtual Portal * findMatchingPortal (Portal *)
 Find a matching portal (for connecting portals)
 
virtual void getAABB (AxisAlignedBox &)
 Get the world coordinate aabb of the zone.
 
SceneNode * getEnclosureNode (void)
 Get a pointer to the enclosure node for this PCZone.
 
unsigned long getLastVisibleFrame (void)
 Get the lastVisibleFrame counter value.
 
PCZCamera * getLastVisibleFromCamera ()
 Get the lastVisibleFromCamera pointer.
 
const String & getName (void) const
 
bool getPortalsUpdated (void)
 
void * getUserData (void)
 Get & set the user data.
 
const String & getZoneTypeName () const
 
bool hasSky (void)
 
void setHasSky (bool yesno)
 If sky should be drawn with this zone.
 
void setLastVisibleFrame (unsigned long frameCount)
 Set the lastVisibleFrame counter.
 
void setLastVisibleFromCamera (PCZCamera *camera)
 Set the lastVisibleFromCamera pointer.
 
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
 
PCZSceneManager * mPCZSM
 Pointer to the pcz scene manager that created this zone.
 
PortalList mPortals
 List of Portals which this zone contains (each portal leads to another zone)
 

Constructor & Destructor Documentation

◆ DefaultZone()

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

◆ ~DefaultZone()

Ogre::DefaultZone::~DefaultZone ( )

Member Function Documentation

◆ setEnclosureNode()

void Ogre::DefaultZone::setEnclosureNode ( PCZSceneNode *  )
overridevirtual

Set the enclosure node for this Zone.

Implements Ogre::PCZone.

◆ _addNode()

void Ogre::DefaultZone::_addNode ( PCZSceneNode *  )
overridevirtual

Adds an SceneNode to this Zone.

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

Implements Ogre::PCZone.

◆ removeNode()

void Ogre::DefaultZone::removeNode ( PCZSceneNode *  )
overridevirtual

Removes all references to a SceneNode from this Zone.

Implements Ogre::PCZone.

◆ requiresZoneSpecificNodeData()

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

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

Implements Ogre::PCZone.

◆ _checkNodeAgainstPortals()

void Ogre::DefaultZone::_checkNodeAgainstPortals ( PCZSceneNode *  ,
Portal *   
)
overridevirtual

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

Implements Ogre::PCZone.

◆ _checkLightAgainstPortals()

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

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

Implements Ogre::PCZone.

◆ updatePortalsZoneData()

void Ogre::DefaultZone::updatePortalsZoneData ( void  )
overridevirtual

Update the zone data for each portal.

Implements Ogre::PCZone.

◆ dirtyNodeByMovingPortals()

void Ogre::DefaultZone::dirtyNodeByMovingPortals ( void  )
overridevirtual

Mark nodes dirty base on moving portals.

Implements Ogre::PCZone.

◆ updateNodeHomeZone()

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

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 
)
overridevirtual

Find and add visible objects to the render queue.

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 
)
overridevirtual

Implements Ogre::PCZone.

◆ _findNodes() [2/4]

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

Implements Ogre::PCZone.

◆ _findNodes() [3/4]

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

Implements Ogre::PCZone.

◆ _findNodes() [4/4]

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

Implements Ogre::PCZone.

◆ setOption()

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

Sets the options for the Zone.

Implements Ogre::PCZone.

◆ notifyCameraCreated()

void Ogre::DefaultZone::notifyCameraCreated ( Camera *  c)
overridevirtual

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

Implements Ogre::PCZone.

◆ notifyWorldGeometryRenderQueue()

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

Called by PCZSM during setWorldGeometryRenderQueue()

Implements Ogre::PCZone.

◆ notifyBeginRenderScene()

void Ogre::DefaultZone::notifyBeginRenderScene ( void  )
overridevirtual

Called when a _renderScene is called in the SceneManager.

Implements Ogre::PCZone.

◆ setZoneGeometry()

void Ogre::DefaultZone::setZoneGeometry ( const String &  filename,
PCZSceneNode *  parentNode 
)
overridevirtual

Called by PCZSM during setZoneGeometry()

Implements Ogre::PCZone.

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