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

AntiPortal datastructure for occlusion culling. More...

#include <OgreAntiPortal.h>

+ Inheritance diagram for Ogre::AntiPortal:

Public Member Functions

 AntiPortal (const String &name, const PORTAL_TYPE type=PORTAL_TYPE_QUAD)
 
virtual ~AntiPortal ()
 
const StringgetMovableType () const
 Returns the type name of this object. More...
 
- Public Member Functions inherited from Ogre::PortalBase
 PortalBase (const String &name, const PORTAL_TYPE type=PORTAL_TYPE_QUAD)
 Constructor. More...
 
virtual ~PortalBase ()
 Destructor. More...
 
void _notifyAttached (Node *parent, bool isTagPoint=false)
 Called when attached to a scene node. More...
 
void _notifyMoved ()
 Called when scene node moved. More...
 
void _updateRenderQueue (RenderQueue *queue)
 Internal method by which the movable object must add Renderable subclass instances to the rendering queue. More...
 
void adjustNodeToMatch (SceneNode *node)
 Adjust the portal so that it is centered and oriented on the given node. More...
 
void calcDirectionAndRadius () const
 Calculate the local direction and radius of the portal. More...
 
bool closeTo (const PortalBase *otherPortal)
 Check if portal touches another portal. More...
 
bool crossedPortal (const PortalBase *otherPortal)
 Check if portal crossed over portal. More...
 
const AxisAlignedBoxgetAAB ()
 Returns an updated AAB of the portal for intersection test. More...
 
const AxisAlignedBoxgetBoundingBox () const
 Retrieves the local axis-aligned bounding box for this object. More...
 
Real getBoundingRadius () const
 Retrieves the radius of the origin-centered bounding sphere for this object. More...
 
const CapsulegetCapsule () const
 Returns an updated capsule of the portal for intersection test. More...
 
const Vector3getCorner (int index) const
 Get the coordinates of one of the portal corners in local space. More...
 
PCZonegetCurrentHomeZone ()
 Get the Zone the Portal is currently "in". More...
 
const Vector3getDerivedCorner (int index) const
 Get the derived (world) coordinates of one of the portal corners. More...
 
const Vector3getDerivedCP () const
 Get the position (centerpoint) of the portal in world coordinates. More...
 
const Vector3getDerivedDirection () const
 Get the direction of the portal in world coordinates. More...
 
const PlanegetDerivedPlane () const
 Get the portal plane in world coordinates. More...
 
const SpheregetDerivedSphere () const
 Get the sphere centered on the derived CP of the portal in world coordinates. More...
 
const Vector3getDirection () const
 Get the direction vector of the portal in local space. More...
 
bool getEnabled () const
 Check if portal is enabled. More...
 
PCZonegetNewHomeZone ()
 Get the Zone the Portal should be moved to. More...
 
const Vector3getPrevDerivedCP () const
 Get the previous position (centerpoint) of the portal in world coordinates. More...
 
const PlanegetPrevDerivedPlane () const
 Get the previous portal plane in world coordinates. More...
 
Real getRadius () const
 Retrieve the radius of the portal (calculates if necessary for quad portals) More...
 
PORTAL_TYPE getType () const
 Get the type of portal. More...
 
virtual const AxisAlignedBoxgetWorldBoundingBox (bool derive=false) const
 Retrieves the axis-aligned bounding box for this object in world coordinates. More...
 
virtual const SpheregetWorldBoundingSphere (bool derive=false) const
 Retrieves the worldspace bounding sphere for this object. More...
 
bool intersects (const AxisAlignedBox &aab)
 Check if portal intersects an aab. More...
 
bool intersects (const PlaneBoundedVolume &pbv)
 Check if portal intersects a plane bounded volume. More...
 
bool intersects (const Ray &ray)
 Check if portal intersects a ray. More...
 
bool intersects (const Sphere &sphere)
 Check if portal intersects an sphere. More...
 
PortalIntersectResult intersects (PCZSceneNode *sn)
 Check for intersection between portal & scenenode (also determines if scenenode crosses over portal. More...
 
bool needUpdate ()
 Returns true if portal needs update. More...
 
void setCorner (int index, const Vector3 &point)
 Set the local coordinates of one of the portal corners. More...
 
void setCorners (const Vector3 *corners)
 Set the local coordinates of all of the portal corners. More...
 
void setCurrentHomeZone (PCZone *zone)
 Set the current home zone of the portal. More...
 
void setDirection (const Vector3 &d)
 Set the "inward/outward norm" direction of AAB or SPHERE portals NOTE: UNIT_Z = "outward" norm, NEGATIVE_UNIT_Z = "inward" norm NOTE: Remember, Portal norms always point towards the zone they are "in". More...
 
void setEnabled (bool value)
 enable the portal More...
 
void setNewHomeZone (PCZone *zone)
 Set the zone this portal should be moved to. More...
 
void setNode (SceneNode *sn)
 Set the SceneNode the Portal is associated with. More...
 
void updateDerivedValues () const
 Update the derived values. More...
 
void visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false)
 Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any. More...
 
- Public Member Functions inherited from Ogre::MovableObject
 MovableObject ()
 Constructor. More...
 
 MovableObject (const String &name)
 Named constructor. More...
 
virtual ~MovableObject ()
 Virtual destructor - read Scott Meyers if you don't know why this is needed. More...
 
MovableObjectFactory_getCreator (void) const
 Get the creator of this object, if any (internal use only) More...
 
LightList_getLightList ()
 Returns a pointer to the current list of lights for this object. More...
 
SceneManager_getManager (void) const
 Get the manager of this object, if any (internal use only) More...
 
virtual const Affine3_getParentNodeFullTransform (void) const
 Return the full transformation of the parent sceneNode or the attachingPoint node. More...
 
virtual void _notifyCreator (MovableObjectFactory *fact)
 Notify the object of it's creator (internal use only) More...
 
virtual void _notifyCurrentCamera (Camera *cam)
 Internal method to notify the object of the camera to be used for the next rendering operation. More...
 
virtual void _notifyManager (SceneManager *man)
 Notify the object of it's manager (internal use only) More...
 
virtual void _releaseManualHardwareResources ()
 Notifies the movable object that hardware resources were lost. More...
 
virtual void _restoreManualHardwareResources ()
 Notifies the movable object that hardware resources should be restored. More...
 
void addQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
void addVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
void detachFromParent (void)
 Detaches an object from a parent SceneNode or TagPoint, if attached. More...
 
bool getCastShadows (void) const
 Returns whether shadow casting is enabled for this object. More...
 
const AxisAlignedBoxgetDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const override
 Gets the world space bounding box of the dark cap, as extruded using the light provided. More...
 
EdgeDatagetEdgeList (void)
 Returns details of the edges which might be used to determine a silhouette. More...
 
const AxisAlignedBoxgetLightCapBounds (void) const override
 Gets the world space bounding box of the light cap. More...
 
uint32 getLightMask () const
 Get a bitwise mask which will filter the lights affecting this object. More...
 
ListenergetListener (void) const
 Gets the current listener for this object. More...
 
const StringgetName (void) const
 Returns the name of this object. More...
 
NodegetParentNode (void) const
 Returns the node to which this object is attached. More...
 
SceneNodegetParentSceneNode (void) const
 Returns the scene node to which this object is attached. More...
 
Real getPointExtrusionDistance (const Light *l) const
 Get the distance to extrude for a point/spot light. More...
 
uint32 getQueryFlags (void) const
 Returns the query flags relevant for this object. More...
 
bool getReceivesShadows ()
 Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows. More...
 
Real getRenderingDistance (void) const
 Gets the distance at which batches are no longer rendered. More...
 
Real getRenderingMinPixelSize () const
 Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
 
uint8 getRenderQueueGroup (void) const
 Gets the queue group for this entity. More...
 
const ShadowRenderableListgetShadowVolumeRenderableList (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDist, unsigned long flags=0)
 Define a default implementation of method from ShadowCaster which implements no shadows. More...
 
virtual uint32 getTypeFlags (void) const
 Get the 'type flags' for this MovableObject. More...
 
const AnygetUserAny (void) const
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
uint32 getVisibilityFlags (void) const
 Returns the visibility flags relevant for this object. More...
 
bool getVisible (void) const
 Gets this object whether to be visible or not, if it has a renderable component. More...
 
bool isAttached (void) const
 Returns true if this object is attached to a SceneNode or TagPoint. More...
 
bool isDebugDisplayEnabled (void) const
 Gets whether debug display of this object is enabled. More...
 
virtual bool isInScene (void) const
 Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph. More...
 
bool isParentTagPoint () const
 Gets whether the parent node is a TagPoint (or a SceneNode) More...
 
virtual bool isVisible (void) const
 Returns whether or not this object is supposed to be visible or not. More...
 
const LightListqueryLights (void) const
 Gets a list of lights, ordered relative to how close they are to this movable object. More...
 
void removeQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
void removeVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
void setCastShadows (bool enabled)
 Sets whether or not this object will cast shadows. More...
 
void setDebugDisplayEnabled (bool enabled)
 Sets whether or not the debug display of this object is enabled. More...
 
void setLightMask (uint32 lightMask)
 Set a bitwise mask which will filter the lights affecting this object. More...
 
void setListener (Listener *listener)
 Sets a listener for this object. More...
 
void setQueryFlags (uint32 flags)
 Sets the query flags for this object. More...
 
void setRenderingDistance (Real dist)
 Sets the distance at which the object is no longer rendered. More...
 
void setRenderingMinPixelSize (Real pixelSize)
 Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
 
virtual void setRenderQueueGroup (uint8 queueID)
 Sets the render queue group this entity will be rendered through. More...
 
virtual void setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)
 Sets the render queue group and group priority this entity will be rendered through. More...
 
void setUserAny (const Any &anything)
 
void setVisibilityFlags (uint32 flags)
 Sets the visibility flags for this object. More...
 
void setVisible (bool visible)
 Tells this object whether to be visible or not, if it has a renderable component. More...
 
- Public Member Functions inherited from Ogre::ShadowCaster
virtual ~ShadowCaster ()
 
virtual ShadowRenderableListIterator getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDistance, unsigned long flags=0)
 
bool hasEdgeList ()
 Returns whether the object has a valid edge list. More...
 
- Public Member Functions inherited from Ogre::AnimableObject
 AnimableObject ()
 
virtual ~AnimableObject ()
 
virtual AnimableValuePtr createAnimableValue (const String &valueName)
 Create a reference-counted AnimableValuePtr for the named value. More...
 
const StringVectorgetAnimableValueNames (void) const
 Gets a list of animable value names for this object. More...
 

Additional Inherited Members

- Public Types inherited from Ogre::PortalBase
enum  PORTAL_TYPE { PORTAL_TYPE_QUAD, PORTAL_TYPE_AABB, PORTAL_TYPE_SPHERE }
 
enum  PortalIntersectResult { NO_INTERSECT, INTERSECT_NO_CROSS, INTERSECT_BACK_NO_CROSS, INTERSECT_CROSS }
 
- Public Types inherited from Ogre::ShadowCaster
typedef std::vector< ShadowRenderable * > ShadowRenderableList
 
typedef VectorIterator< ShadowRenderableListShadowRenderableListIterator
 
- Static Public Member Functions inherited from Ogre::MovableObject
static uint32 getDefaultQueryFlags ()
 Get the default query flags for all future MovableObject instances. More...
 
static uint32 getDefaultVisibilityFlags ()
 Get the default visibility flags for all future MovableObject instances. More...
 
static void setDefaultQueryFlags (uint32 flags)
 Set the default query flags for all future MovableObject instances. More...
 
static void setDefaultVisibilityFlags (uint32 flags)
 Set the default visibility flags for all future MovableObject instances. More...
 
- Static Public Member Functions inherited from Ogre::ShadowCaster
static void clearShadowRenderableList (ShadowRenderableList &shadowRenderables)
 Common implementation of releasing shadow renderables. More...
 
static void extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist)
 Utility method for extruding vertices based on a light. More...
 

Detailed Description

AntiPortal datastructure for occlusion culling.

Constructor & Destructor Documentation

◆ AntiPortal()

Ogre::AntiPortal::AntiPortal ( const String name,
const PORTAL_TYPE  type = PORTAL_TYPE_QUAD 
)

◆ ~AntiPortal()

virtual Ogre::AntiPortal::~AntiPortal ( )
virtual

Member Function Documentation

◆ getMovableType()

const String& Ogre::AntiPortal::getMovableType ( ) const
virtual

Returns the type name of this object.

Implements Ogre::MovableObject.


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