Portal datastructure for connecting zones. More...

#include <OgrePortal.h>

Inheritance diagram for Ogre::Portal:

Public Types
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 }

typedef std::vector< ShadowRenderable * >	ShadowRenderableList

typedef VectorIterator< ShadowRenderableList >	ShadowRenderableListIterator

Public Member Functions
	Portal (const String &name, const PORTAL_TYPE type=PORTAL_TYPE_QUAD)

virtual	~Portal ()

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...

void	_notifyAttached (Node *parent, bool isTagPoint=false)
	Called when attached to a scene 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...

void	_notifyMoved ()
	Called when scene node moved. 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	_updateRenderQueue (RenderQueue *queue)
	Internal method by which the movable object must add Renderable subclass instances to the rendering queue. 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	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...

virtual AnimableValuePtr	createAnimableValue (const String &valueName)
	Create a reference-counted AnimableValuePtr for the named value. More...

bool	crossedPortal (const PortalBase *otherPortal)
	Check if portal crossed over portal. More...

void	detachFromParent (void)
	Detaches an object from a parent SceneNode or TagPoint, if attached. More...

const AxisAlignedBox &	getAAB ()
	Returns an updated AAB of the portal for intersection test. More...

const StringVector &	getAnimableValueNames (void) const
	Gets a list of animable value names for this object. More...

const AxisAlignedBox &	getBoundingBox () 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 Capsule &	getCapsule () const
	Returns an updated capsule of the portal for intersection test. More...

bool	getCastShadows (void) const
	Returns whether shadow casting is enabled for this object. More...

const Vector3 &	getCorner (int index) const
	Get the coordinates of one of the portal corners in local space. More...

PCZone *	getCurrentHomeZone ()
	Get the Zone the Portal is currently "in". More...

const AxisAlignedBox &	getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const
	Overridden member from ShadowCaster. More...

const Vector3 &	getDerivedCorner (int index) const
	Get the derived (world) coordinates of one of the portal corners. More...

const Vector3 &	getDerivedCP () const
	Get the position (centerpoint) of the portal in world coordinates. More...

const Vector3 &	getDerivedDirection () const
	Get the direction of the portal in world coordinates. More...

const Plane &	getDerivedPlane () const
	Get the portal plane in world coordinates. More...

const Sphere &	getDerivedSphere () const
	Get the sphere centered on the derived CP of the portal in world coordinates. More...

const Vector3 &	getDirection () const
	Get the direction vector of the portal in local space. More...

EdgeData *	getEdgeList (void)
	Returns details of the edges which might be used to determine a silhouette. More...

bool	getEnabled () const
	Check if portal is enabled. More...

const AxisAlignedBox &	getLightCapBounds (void) const
	Overridden member from ShadowCaster. More...

uint32	getLightMask () const
	Get a bitwise mask which will filter the lights affecting this object. More...

Listener *	getListener (void) const
	Gets the current listener for this object. More...

const String &	getMovableType () const
	Returns the type name of this object. More...

const String &	getName (void) const
	Returns the name of this object. More...

PCZone *	getNewHomeZone ()
	Get the Zone the Portal should be moved to. More...

Node *	getParentNode (void) const
	Returns the node to which this object is attached. More...

SceneNode *	getParentSceneNode (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...

const Vector3 &	getPrevDerivedCP () const
	Get the previous position (centerpoint) of the portal in world coordinates. More...

const Plane &	getPrevDerivedPlane () const
	Get the previous portal plane in world coordinates. More...

uint32	getQueryFlags (void) const
	Returns the query flags relevant for this object. More...

Real	getRadius () const
	Retrieve the radius of the portal (calculates if necessary for quad portals) 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...

ShadowRenderableListIterator	getShadowVolumeRenderableIterator (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...

Portal *	getTargetPortal ()
	Get the connected portal (if any) More...

PCZone *	getTargetZone ()
	Get the Zone the Portal connects to. More...

PORTAL_TYPE	getType () const
	Get the type of portal. More...

virtual uint32	getTypeFlags (void) const
	Get the 'type flags' for this MovableObject. More...

const Any &	getUserAny (void) const

UserObjectBindings &	getUserObjectBindings ()
	Return an instance of user objects binding associated with this class. More...

const UserObjectBindings &	getUserObjectBindings () 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...

virtual const AxisAlignedBox &	getWorldBoundingBox (bool derive=false) const
	Retrieves the axis-aligned bounding box for this object in world coordinates. More...

virtual const Sphere &	getWorldBoundingSphere (bool derive=false) const
	Retrieves the worldspace bounding sphere for this object. More...

bool	hasEdgeList (void)
	Returns whether the object has a valid edge list. More...

bool	intersects (const AxisAlignedBox &aab)
	Check if portal intersects an aab. More...

bool	intersects (const Sphere &sphere)
	Check if portal intersects an sphere. 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...

PortalIntersectResult	intersects (PCZSceneNode *sn)
	Check for intersection between portal & scenenode (also determines if scenenode crosses over portal. 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...

bool	needUpdate ()
	Returns true if portal needs update. More...

const LightList &	queryLights (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	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	setDebugDisplayEnabled (bool enabled)
	Sets whether or not the debug display of this object is enabled. 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	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	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	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	setTargetPortal (Portal *portal)
	Set the target portal pointer. More...

void	setTargetZone (PCZone *zone)

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...

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...

Static Public Member Functions
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...

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...

Detailed Description

Portal datastructure for connecting zones.

Member Typedef Documentation

◆ ShadowRenderableList

typedef std::vector<ShadowRenderable*> Ogre::ShadowCaster::ShadowRenderableList

inherited

◆ ShadowRenderableListIterator

typedef VectorIterator<ShadowRenderableList> Ogre::ShadowCaster::ShadowRenderableListIterator

inherited

Member Enumeration Documentation

◆ PORTAL_TYPE

enum Ogre::PortalBase::PORTAL_TYPE

inherited

Enumerator
PORTAL_TYPE_QUAD
PORTAL_TYPE_AABB
PORTAL_TYPE_SPHERE

◆ PortalIntersectResult

enum Ogre::PortalBase::PortalIntersectResult

inherited

Enumerator
NO_INTERSECT
INTERSECT_NO_CROSS
INTERSECT_BACK_NO_CROSS
INTERSECT_CROSS

Constructor & Destructor Documentation

◆ Portal()

Ogre::Portal::Portal	(	const String &	name,
		const PORTAL_TYPE	type = `PORTAL_TYPE_QUAD`
	)

◆ ~Portal()

virtual Ogre::Portal::~Portal ( )

virtual

Member Function Documentation

◆ setTargetZone()

void Ogre::Portal::setTargetZone ( PCZone * zone )

◆ setTargetPortal()

void Ogre::Portal::setTargetPortal ( Portal * portal )

Set the target portal pointer.

◆ getTargetZone()

PCZone* Ogre::Portal::getTargetZone ( )

inline

Get the Zone the Portal connects to.

◆ getTargetPortal()

Portal* Ogre::Portal::getTargetPortal ( )

inline

Get the connected portal (if any)

◆ getMovableType()

const String& Ogre::Portal::getMovableType ( ) const

virtual

Returns the type name of this object.

Implements Ogre::MovableObject.

◆ getWorldBoundingBox()

virtual const AxisAlignedBox& Ogre::PortalBase::getWorldBoundingBox ( bool derive = false ) const

virtualinherited

Retrieves the axis-aligned bounding box for this object in world coordinates.

Reimplemented from Ogre::MovableObject.

◆ getWorldBoundingSphere()

virtual const Sphere& Ogre::PortalBase::getWorldBoundingSphere ( bool derive = false ) const

virtualinherited

Retrieves the worldspace bounding sphere for this object.

Reimplemented from Ogre::MovableObject.

◆ setNode()

void Ogre::PortalBase::setNode ( SceneNode * sn )

inherited

Set the SceneNode the Portal is associated with.

◆ setCurrentHomeZone()

void Ogre::PortalBase::setCurrentHomeZone ( PCZone * zone )

inherited

Set the current home zone of the portal.

◆ setNewHomeZone()

void Ogre::PortalBase::setNewHomeZone ( PCZone * zone )

inherited

Set the zone this portal should be moved to.

◆ setCorner()

void Ogre::PortalBase::setCorner	(	int	index,
		const Vector3 &	point
	)

inherited

Set the local coordinates of one of the portal corners.

◆ setCorners()

void Ogre::PortalBase::setCorners ( const Vector3 * corners )

inherited

Set the local coordinates of all of the portal corners.

◆ setDirection()

void Ogre::PortalBase::setDirection ( const Vector3 & d )

inlineinherited

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".

References Ogre::Exception::ERR_INVALIDPARAMS, and OGRE_EXCEPT.

◆ calcDirectionAndRadius()

void Ogre::PortalBase::calcDirectionAndRadius ( ) const

inherited

Calculate the local direction and radius of the portal.

◆ getType()

PORTAL_TYPE Ogre::PortalBase::getType ( void ) const

inlineinherited

Get the type of portal.

◆ getRadius()

Real Ogre::PortalBase::getRadius ( ) const

inherited

Retrieve the radius of the portal (calculates if necessary for quad portals)

◆ getCurrentHomeZone()

PCZone* Ogre::PortalBase::getCurrentHomeZone ( )

inlineinherited

Get the Zone the Portal is currently "in".

◆ getNewHomeZone()

PCZone* Ogre::PortalBase::getNewHomeZone ( )

inlineinherited

Get the Zone the Portal should be moved to.

◆ getCorner()

const Vector3& Ogre::PortalBase::getCorner ( int index ) const

inlineinherited

Get the coordinates of one of the portal corners in local space.

◆ getDirection()

const Vector3& Ogre::PortalBase::getDirection ( ) const

inlineinherited

Get the direction vector of the portal in local space.

◆ getDerivedCorner()

const Vector3& Ogre::PortalBase::getDerivedCorner ( int index ) const

inlineinherited

Get the derived (world) coordinates of one of the portal corners.

◆ getDerivedDirection()

const Vector3& Ogre::PortalBase::getDerivedDirection ( ) const

inlineinherited

Get the direction of the portal in world coordinates.

◆ getDerivedCP()

const Vector3& Ogre::PortalBase::getDerivedCP ( ) const

inlineinherited

Get the position (centerpoint) of the portal in world coordinates.

◆ getDerivedSphere()

const Sphere& Ogre::PortalBase::getDerivedSphere ( ) const

inlineinherited

Get the sphere centered on the derived CP of the portal in world coordinates.

◆ getDerivedPlane()

const Plane& Ogre::PortalBase::getDerivedPlane ( ) const

inlineinherited

Get the portal plane in world coordinates.

◆ getPrevDerivedCP()

const Vector3& Ogre::PortalBase::getPrevDerivedCP ( ) const

inlineinherited

Get the previous position (centerpoint) of the portal in world coordinates.

◆ getPrevDerivedPlane()

const Plane& Ogre::PortalBase::getPrevDerivedPlane ( ) const

inlineinherited

Get the previous portal plane in world coordinates.

◆ updateDerivedValues()

void Ogre::PortalBase::updateDerivedValues ( ) const

inherited

Update the derived values.

◆ adjustNodeToMatch()

void Ogre::PortalBase::adjustNodeToMatch ( SceneNode * node )

inherited

Adjust the portal so that it is centered and oriented on the given node.

◆ setEnabled()

void Ogre::PortalBase::setEnabled ( bool value )

inlineinherited

enable the portal

◆ getEnabled()

bool Ogre::PortalBase::getEnabled ( ) const

inlineinherited

Check if portal is enabled.

◆ intersects() [1/5]

bool Ogre::PortalBase::intersects ( const AxisAlignedBox & aab )

inherited

Check if portal intersects an aab.

◆ intersects() [2/5]

bool Ogre::PortalBase::intersects ( const Sphere & sphere )

inherited

Check if portal intersects an sphere.

◆ intersects() [3/5]

bool Ogre::PortalBase::intersects ( const PlaneBoundedVolume & pbv )

inherited

Check if portal intersects a plane bounded volume.

◆ intersects() [4/5]

bool Ogre::PortalBase::intersects ( const Ray & ray )

inherited

Check if portal intersects a ray.

◆ intersects() [5/5]

PortalIntersectResult Ogre::PortalBase::intersects ( PCZSceneNode * sn )

inherited

Check for intersection between portal & scenenode (also determines if scenenode crosses over portal.

◆ crossedPortal()

bool Ogre::PortalBase::crossedPortal ( const PortalBase * otherPortal )

inherited

Check if portal crossed over portal.

◆ closeTo()

bool Ogre::PortalBase::closeTo ( const PortalBase * otherPortal )

inherited

Check if portal touches another portal.

◆ getBoundingBox()

const AxisAlignedBox& Ogre::PortalBase::getBoundingBox ( ) const

virtualinherited

Retrieves the local axis-aligned bounding box for this object.

Remarks: This bounding box is in local coordinates.

Implements Ogre::MovableObject.

◆ getBoundingRadius()

Real Ogre::PortalBase::getBoundingRadius ( void ) const

inlinevirtualinherited

Retrieves the radius of the origin-centered bounding sphere for this object.

Implements Ogre::MovableObject.

◆ _updateRenderQueue()

void Ogre::PortalBase::_updateRenderQueue ( RenderQueue * queue )

inlinevirtualinherited

Internal method by which the movable object must add Renderable subclass instances to the rendering queue.

Remarks: The engine will call this method when this object is to be rendered. The object must then create one or more Renderable subclass instances which it places on the passed in Queue for rendering.

Implements Ogre::MovableObject.

◆ visitRenderables()

void Ogre::PortalBase::visitRenderables	(	Renderable::Visitor *	visitor,
		bool	debugRenderables = `false`
	)

inlinevirtualinherited

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.

Parameters

visitor	Pointer to a class implementing the Renderable::Visitor interface which will be called back for each Renderable which will be queued. Bear in mind that the state of the Renderable instances may not be finalised depending on when you call this.
debugRenderables	If false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too.

Implements Ogre::MovableObject.

◆ _notifyMoved()

void Ogre::PortalBase::_notifyMoved ( void )

inlinevirtualinherited

Called when scene node moved.

Reimplemented from Ogre::MovableObject.

◆ _notifyAttached()

void Ogre::PortalBase::_notifyAttached	(	Node *	parent,
		bool	isTagPoint = `false`
	)

inlinevirtualinherited

Called when attached to a scene node.

Reimplemented from Ogre::MovableObject.

References Ogre::MovableObject::_notifyAttached().

◆ needUpdate()

bool Ogre::PortalBase::needUpdate ( )

inherited

Returns true if portal needs update.

◆ getCapsule()

const Capsule& Ogre::PortalBase::getCapsule ( ) const

inherited

Returns an updated capsule of the portal for intersection test.

◆ getAAB()

const AxisAlignedBox& Ogre::PortalBase::getAAB ( )

inherited

Returns an updated AAB of the portal for intersection test.

◆ _notifyCreator()

virtual void Ogre::MovableObject::_notifyCreator ( MovableObjectFactory * fact )

inlinevirtualinherited

Notify the object of it's creator (internal use only)

◆ _getCreator()

MovableObjectFactory* Ogre::MovableObject::_getCreator ( void ) const

inlineinherited

Get the creator of this object, if any (internal use only)

◆ _notifyManager()

virtual void Ogre::MovableObject::_notifyManager ( SceneManager * man )

inlinevirtualinherited

Notify the object of it's manager (internal use only)

◆ _getManager()

SceneManager* Ogre::MovableObject::_getManager ( void ) const

inlineinherited

Get the manager of this object, if any (internal use only)

◆ _releaseManualHardwareResources()

virtual void Ogre::MovableObject::_releaseManualHardwareResources ( )

inlinevirtualinherited

Notifies the movable object that hardware resources were lost.

Remarks: Called automatically by RenderSystem if hardware resources were lost and can not be restored using some internal mechanism. Among affected resources are nested shadow renderables, ManualObjects, etc.

Reimplemented in Ogre::BillboardSet, Ogre::StaticGeometry::Region, Ogre::Entity, and Ogre::ManualObject.

◆ _restoreManualHardwareResources()

virtual void Ogre::MovableObject::_restoreManualHardwareResources ( )

inlinevirtualinherited

Notifies the movable object that hardware resources should be restored.

Remarks: Called automatically by RenderSystem if hardware resources were lost and can not be restored using some internal mechanism. Among affected resources are nested shadow renderables, ManualObjects, etc.

Reimplemented in Ogre::StaticGeometry::Region, and Ogre::Entity.

◆ getName()

const String& Ogre::MovableObject::getName ( void ) const

inlineinherited

Returns the name of this object.

◆ getParentNode()

Node* Ogre::MovableObject::getParentNode ( void ) const

inlineinherited

Returns the node to which this object is attached.

Remarks: A MovableObject may be attached to either a SceneNode or to a TagPoint, the latter case if it's attached to a bone on an animated entity. Both are Node subclasses so this method will return either.

◆ getParentSceneNode()

SceneNode* Ogre::MovableObject::getParentSceneNode ( void ) const

inherited

Returns the scene node to which this object is attached.

Remarks: A MovableObject may be attached to either a SceneNode or to a TagPoint, the latter case if it's attached to a bone on an animated entity. This method will return the scene node of the parent entity if the latter is true.

◆ isParentTagPoint()

bool Ogre::MovableObject::isParentTagPoint ( ) const

inlineinherited

Gets whether the parent node is a TagPoint (or a SceneNode)

◆ isAttached()

bool Ogre::MovableObject::isAttached ( void ) const

inlineinherited

Returns true if this object is attached to a SceneNode or TagPoint.

◆ detachFromParent()

void Ogre::MovableObject::detachFromParent ( void )

inherited

Detaches an object from a parent SceneNode or TagPoint, if attached.

◆ isInScene()

virtual bool Ogre::MovableObject::isInScene ( void ) const

virtualinherited

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.

Reimplemented in Ogre::InstancedEntity.

◆ _notifyCurrentCamera()

virtual void Ogre::MovableObject::_notifyCurrentCamera ( Camera * cam )

virtualinherited

Internal method to notify the object of the camera to be used for the next rendering operation.

Remarks: Certain objects may want to do specific processing based on the camera position. This method notifies them in case they wish to do this.

Reimplemented in Ogre::BillboardSet, Ogre::Frustum, Ogre::StaticGeometry::Region, Ogre::Entity, Ogre::ParticleSystem, Ogre::InstanceBatch, Ogre::SimpleRenderable, and Ogre::MovablePlane.

◆ setVisible()

void Ogre::MovableObject::setVisible ( bool visible )

inlineinherited

Tells this object whether to be visible or not, if it has a renderable component.

Note: An alternative approach of making an object invisible is to detach it from it's SceneNode, or to remove the SceneNode entirely. Detaching a node means that structurally the scene graph changes. Once this change has taken place, the objects / nodes that have been removed have less overhead to the visibility detection pass than simply making the object invisible, so if you do this and leave the objects out of the tree for a long time, it's faster. However, the act of detaching / reattaching nodes is in itself more expensive than setting an object visibility flag, since in the latter case structural changes are not made. Therefore, small or frequent visibility changes are best done using this method; large or more longer term changes are best done by detaching.

Referenced by Ogre::Light::setVisible().

◆ getVisible()

bool Ogre::MovableObject::getVisible ( void ) const

inlineinherited

Gets this object whether to be visible or not, if it has a renderable component.

Remarks: Returns the value set by MovableObject::setVisible only.

◆ isVisible()

virtual bool Ogre::MovableObject::isVisible ( void ) const

virtualinherited

Returns whether or not this object is supposed to be visible or not.

Remarks: Takes into account both upper rendering distance and visible flag.

Reimplemented in Ogre::StaticGeometry::Region.

Referenced by Ogre::Frustum::isCustomProjectionMatrixEnabled().

◆ setRenderingDistance()

void Ogre::MovableObject::setRenderingDistance ( Real dist )

inlineinherited

Sets the distance at which the object is no longer rendered.

Note: Camera::setUseRenderingDistance() needs to be called for this parameter to be used.

Parameters

dist	Distance beyond which the object will not be rendered (the default is 0, which means objects are always rendered).

◆ getRenderingDistance()

Real Ogre::MovableObject::getRenderingDistance ( void ) const

inlineinherited

Gets the distance at which batches are no longer rendered.

◆ setRenderingMinPixelSize()

void Ogre::MovableObject::setRenderingMinPixelSize ( Real pixelSize )

inlineinherited

Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.

Note: Camera::setUseMinPixelSize() needs to be called for this parameter to be used.

Parameters

pixelSize Number of minimum pixels (the default is 0, which means objects are always rendered).

◆ getRenderingMinPixelSize()

Real Ogre::MovableObject::getRenderingMinPixelSize ( ) const

inlineinherited

Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.

◆ setUserAny()

void Ogre::MovableObject::setUserAny ( const Any & anything )

inlineinherited

Deprecated:: use UserObjectBindings::setUserAny via getUserObjectBindings() instead.

Sets any kind of user value on this object.

Remarks: This method allows you to associate any user value you like with this MovableObject. This can be a pointer back to one of your own classes for instance.

◆ getUserAny()

const Any& Ogre::MovableObject::getUserAny ( void ) const

inlineinherited

Deprecated:: use UserObjectBindings::getUserAny via getUserObjectBindings() instead.

Retrieves the custom user value associated with this object.

◆ getUserObjectBindings() [1/2]

UserObjectBindings& Ogre::MovableObject::getUserObjectBindings ( )

inlineinherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also: UserObjectBindings::setUserAny.

◆ getUserObjectBindings() [2/2]

const UserObjectBindings& Ogre::MovableObject::getUserObjectBindings ( ) const

inlineinherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also: UserObjectBindings::setUserAny.

◆ setRenderQueueGroup()

virtual void Ogre::MovableObject::setRenderQueueGroup ( uint8 queueID )

virtualinherited

Sets the render queue group this entity will be rendered through.

Remarks: Render queues are grouped to allow you to more tightly control the ordering of rendered objects. If you do not call this method, all Entity objects default to the default queue (RenderQueue::getDefaultQueueGroup), which is fine for most objects. You may want to alter this if you want this entity to always appear in front of other objects, e.g. for a 3D menu system or such.

: See RenderQueue for more details.

Parameters

queueID Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.

Reimplemented in Ogre::ParticleSystem, and Ogre::Entity.

◆ setRenderQueueGroupAndPriority()

virtual void Ogre::MovableObject::setRenderQueueGroupAndPriority	(	uint8	queueID,
		ushort	priority
	)

virtualinherited

Sets the render queue group and group priority this entity will be rendered through.

Remarks: Render queues are grouped to allow you to more tightly control the ordering of rendered objects. Within a single render group there another type of grouping called priority which allows further control. If you do not call this method, all Entity objects default to the default queue and priority (RenderQueue::getDefaultQueueGroup, RenderQueue::getDefaultRenderablePriority), which is fine for most objects. You may want to alter this if you want this entity to always appear in front of other objects, e.g. for a 3D menu system or such.

: See RenderQueue for more details.

Parameters

queueID	Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.
priority	The priority within a group to use.

Reimplemented in Ogre::ParticleSystem, and Ogre::Entity.

◆ getRenderQueueGroup()

uint8 Ogre::MovableObject::getRenderQueueGroup ( void ) const

inlineinherited

Gets the queue group for this entity.

See also: setRenderQueueGroup

◆ _getParentNodeFullTransform()

virtual const Affine3& Ogre::MovableObject::_getParentNodeFullTransform ( void ) const

virtualinherited

Return the full transformation of the parent sceneNode or the attachingPoint node.

Reimplemented in Ogre::InstancedEntity.

◆ setQueryFlags()

void Ogre::MovableObject::setQueryFlags ( uint32 flags )

inlineinherited

Sets the query flags for this object.

Remarks: When performing a scene query, this object will be included or excluded according to flags on the object and flags on the query. This is a bitwise value, so only when a bit on these flags is set, will it be included in a query asking for that flag. The meaning of the bits is application-specific.

◆ addQueryFlags()

void Ogre::MovableObject::addQueryFlags ( uint32 flags )

inlineinherited

As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.

◆ removeQueryFlags()

void Ogre::MovableObject::removeQueryFlags ( uint32 flags )

inlineinherited

As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.

◆ getQueryFlags()

uint32 Ogre::MovableObject::getQueryFlags ( void ) const

inlineinherited

Returns the query flags relevant for this object.

◆ setDefaultQueryFlags()

static void Ogre::MovableObject::setDefaultQueryFlags ( uint32 flags )

inlinestaticinherited

Set the default query flags for all future MovableObject instances.

◆ getDefaultQueryFlags()

static uint32 Ogre::MovableObject::getDefaultQueryFlags ( )

inlinestaticinherited

Get the default query flags for all future MovableObject instances.

◆ setVisibilityFlags()

void Ogre::MovableObject::setVisibilityFlags ( uint32 flags )

inlineinherited

Sets the visibility flags for this object.

Remarks: As well as a simple true/false value for visibility (as seen in setVisible), you can also set visibility flags which when 'and'ed with the SceneManager's visibility mask can also make an object invisible.

◆ addVisibilityFlags()

void Ogre::MovableObject::addVisibilityFlags ( uint32 flags )

inlineinherited

As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.

◆ removeVisibilityFlags()

void Ogre::MovableObject::removeVisibilityFlags ( uint32 flags )

inlineinherited

As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.

◆ getVisibilityFlags()

uint32 Ogre::MovableObject::getVisibilityFlags ( void ) const

inlineinherited

Returns the visibility flags relevant for this object.

◆ setDefaultVisibilityFlags()

static void Ogre::MovableObject::setDefaultVisibilityFlags ( uint32 flags )

inlinestaticinherited

Set the default visibility flags for all future MovableObject instances.

◆ getDefaultVisibilityFlags()

static uint32 Ogre::MovableObject::getDefaultVisibilityFlags ( )

inlinestaticinherited

Get the default visibility flags for all future MovableObject instances.

◆ setListener()

void Ogre::MovableObject::setListener ( Listener * listener )

inlineinherited

Sets a listener for this object.

Remarks: Note for size and performance reasons only one listener per object is allowed.

◆ getListener()

Listener* Ogre::MovableObject::getListener ( void ) const

inlineinherited

Gets the current listener for this object.

◆ queryLights()

const LightList& Ogre::MovableObject::queryLights ( void ) const

inherited

Gets a list of lights, ordered relative to how close they are to this movable object.

Remarks: By default, this method gives the listener a chance to populate light list first, if there is no listener or Listener::objectQueryLights returns NULL, it'll query the light list from parent entity if it is present, or returns SceneNode::findLights if it has parent scene node, otherwise it just returns an empty list.

: The object internally caches the light list, so it will recalculate it only when object is moved, or lights that affect the frustum have been changed (

See also: SceneManager::_getLightsDirtyCounter), but if listener exists, it will be called each time, so the listener should implement their own cache mechanism to optimise performance.

: This method can be useful when implementing Renderable::getLights in case the renderable is a part of the movable.

Returns: The list of lights use to lighting this object.

◆ getLightMask()

uint32 Ogre::MovableObject::getLightMask ( ) const

inlineinherited

Get a bitwise mask which will filter the lights affecting this object.

Remarks: By default, this mask is fully set meaning all lights will affect this object

◆ setLightMask()

void Ogre::MovableObject::setLightMask ( uint32 lightMask )

inherited

Set a bitwise mask which will filter the lights affecting this object.

Remarks: This mask will be compared against the mask held against Light to determine if a light should affect a given object. By default, this mask is fully set meaning all lights will affect this object

◆ _getLightList()

LightList* Ogre::MovableObject::_getLightList ( )

inlineinherited

Returns a pointer to the current list of lights for this object.

Remarks: You should not modify this list outside of MovableObject::Listener::objectQueryLights (say if you want to use it to implement this method, and use the pointer as a return value) and for reading it's only accurate as at the last frame.

◆ getEdgeList()

EdgeData* Ogre::MovableObject::getEdgeList ( void )

inlinevirtualinherited

Returns details of the edges which might be used to determine a silhouette.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

◆ hasEdgeList()

bool Ogre::MovableObject::hasEdgeList ( void )

inlinevirtualinherited

Returns whether the object has a valid edge list.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

◆ getShadowVolumeRenderableIterator()

ShadowRenderableListIterator Ogre::MovableObject::getShadowVolumeRenderableIterator	(	ShadowTechnique	shadowTechnique,
		const Light *	light,
		HardwareIndexBufferSharedPtr *	indexBuffer,
		size_t *	indexBufferUsedSize,
		bool	extrudeVertices,
		Real	extrusionDist,
		unsigned long	flags = `0`
	)

virtualinherited

Define a default implementation of method from ShadowCaster which implements no shadows.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

◆ getLightCapBounds()

const AxisAlignedBox& Ogre::MovableObject::getLightCapBounds ( void ) const

virtualinherited

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

◆ getDarkCapBounds()

const AxisAlignedBox& Ogre::MovableObject::getDarkCapBounds	(	const Light &	light,
		Real	dirLightExtrusionDist
	)		const

virtualinherited

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

◆ setCastShadows()

void Ogre::MovableObject::setCastShadows ( bool enabled )

inlineinherited

Sets whether or not this object will cast shadows.

Remarks: This setting simply allows you to turn on/off shadows for a given object. An object will not cast shadows unless the scene supports it in any case (see SceneManager::setShadowTechnique), and also the material which is in use must also have shadow casting enabled. By default all entities cast shadows. If, however, for some reason you wish to disable this for a single object then you can do so using this method.

Note: This method normally refers to objects which block the light, but since Light is also a subclass of MovableObject, in that context it means whether the light causes shadows itself.

◆ getCastShadows()

bool Ogre::MovableObject::getCastShadows ( void ) const

inlinevirtualinherited

Returns whether shadow casting is enabled for this object.

Implements Ogre::ShadowCaster.

◆ getReceivesShadows()

bool Ogre::MovableObject::getReceivesShadows ( )

inherited

Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.

◆ getPointExtrusionDistance()

Real Ogre::MovableObject::getPointExtrusionDistance ( const Light * l ) const

virtualinherited

Get the distance to extrude for a point/spot light.

Implements Ogre::ShadowCaster.

◆ getTypeFlags()

virtual uint32 Ogre::MovableObject::getTypeFlags ( void ) const

virtualinherited

Get the 'type flags' for this MovableObject.

Remarks: A type flag identifies the type of the MovableObject as a bitpattern. This is used for categorical inclusion / exclusion in SceneQuery objects. By default, this method returns all ones for objects not created by a MovableObjectFactory (hence always including them); otherwise it returns the value assigned to the MovableObjectFactory. Custom objects which don't use MovableObjectFactory will need to override this if they want to be included in queries.

Reimplemented in Ogre::BillboardSet, Ogre::Entity, Ogre::ParticleSystem, Ogre::Frustum, Ogre::StaticGeometry::Region, and Ogre::Light.

◆ setDebugDisplayEnabled()

void Ogre::MovableObject::setDebugDisplayEnabled ( bool enabled )

inlineinherited

Sets whether or not the debug display of this object is enabled.

Remarks: Some objects aren't visible themselves but it can be useful to display a debug representation of them. Or, objects may have an additional debug display on top of their regular display. This option enables / disables that debug display. Objects that are not visible never display debug geometry regardless of this setting.

◆ isDebugDisplayEnabled()

bool Ogre::MovableObject::isDebugDisplayEnabled ( void ) const

inlineinherited

Gets whether debug display of this object is enabled.

◆ clearShadowRenderableList()

static void Ogre::ShadowCaster::clearShadowRenderableList ( ShadowRenderableList & shadowRenderables )

staticinherited

Common implementation of releasing shadow renderables.

◆ extrudeVertices()

static void Ogre::ShadowCaster::extrudeVertices	(	const HardwareVertexBufferSharedPtr &	vertexBuffer,
		size_t	originalVertexCount,
		const Vector4 &	lightPos,
		Real	extrudeDist
	)

staticinherited

Utility method for extruding vertices based on a light.

Remarks: Unfortunately, because D3D cannot handle homogeneous (4D) position coordinates in the fixed-function pipeline (GL can, but we have to be cross-API), when we extrude in software we cannot extrude to infinity the way we do in the vertex program (by setting w to 0.0f). Therefore we extrude by a fixed distance, which may cause some problems with larger scenes. Luckily better hardware (ie vertex programs) can fix this.

Parameters

vertexBuffer	The vertex buffer containing ONLY xyz position values, which must be originalVertexCount * 2 * 3 floats long.
originalVertexCount	The count of the original number of vertices, i.e. the number in the mesh, not counting the doubling which has already been done (by VertexData::prepareForShadowVolume) to provide the extruded area of the buffer.
lightPos	4D light position in object space, when w=0.0f this represents a directional light.
extrudeDist	The distance to extrude.

◆ getAnimableValueNames()

const StringVector& Ogre::AnimableObject::getAnimableValueNames ( void ) const

inlineinherited

Gets a list of animable value names for this object.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

◆ createAnimableValue()

virtual AnimableValuePtr Ogre::AnimableObject::createAnimableValue ( const String & valueName )

inlinevirtualinherited

Create a reference-counted AnimableValuePtr for the named value.

Remarks: You can use the returned object to animate a value on this object, using AnimationTrack. Subclasses must override this if they wish to support animation of their values.

Reimplemented in Ogre::Light.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

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

OgrePortal.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ShadowRenderableList

◆ ShadowRenderableListIterator

Member Enumeration Documentation

◆ PORTAL_TYPE

◆ PortalIntersectResult

Constructor & Destructor Documentation

◆ Portal()

◆ ~Portal()

Member Function Documentation

◆ setTargetZone()

◆ setTargetPortal()

◆ getTargetZone()

◆ getTargetPortal()

◆ getMovableType()

◆ getWorldBoundingBox()

◆ getWorldBoundingSphere()

◆ setNode()

◆ setCurrentHomeZone()

◆ setNewHomeZone()

◆ setCorner()

◆ setCorners()

◆ setDirection()

◆ calcDirectionAndRadius()

◆ getType()

◆ getRadius()

◆ getCurrentHomeZone()

◆ getNewHomeZone()

◆ getCorner()

◆ getDirection()

◆ getDerivedCorner()

◆ getDerivedDirection()

◆ getDerivedCP()

◆ getDerivedSphere()

◆ getDerivedPlane()

◆ getPrevDerivedCP()

◆ getPrevDerivedPlane()

◆ updateDerivedValues()

◆ adjustNodeToMatch()

◆ setEnabled()

◆ getEnabled()

◆ intersects() [1/5]

◆ intersects() [2/5]

◆ intersects() [3/5]

◆ intersects() [4/5]

◆ intersects() [5/5]

◆ crossedPortal()

◆ closeTo()

◆ getBoundingBox()

◆ getBoundingRadius()

◆ _updateRenderQueue()

◆ visitRenderables()

◆ _notifyMoved()

◆ _notifyAttached()

◆ needUpdate()

◆ getCapsule()

◆ getAAB()

◆ _notifyCreator()

◆ _getCreator()

◆ _notifyManager()

◆ _getManager()

◆ _releaseManualHardwareResources()

◆ _restoreManualHardwareResources()

◆ getName()

◆ getParentNode()

◆ getParentSceneNode()

◆ isParentTagPoint()

◆ isAttached()

◆ detachFromParent()

◆ isInScene()

◆ _notifyCurrentCamera()

◆ setVisible()

◆ getVisible()

◆ isVisible()

◆ setRenderingDistance()

◆ getRenderingDistance()