Ogre::MovablePlane Class Reference

Definition of a Plane that may be attached to a node, and the derived details of it retrieved simply. More...

#include <OgreMovablePlane.h>

Inheritance diagram for Ogre::MovablePlane:

Public Member Functions
	MovablePlane (const Plane &rhs)
	MovablePlane (const String &name)
	MovablePlane (const Vector3 &rkNormal, const Vector3 &rkPoint)
	MovablePlane (const Vector3 &rkNormal, Real fConstant)
	Construct a plane through a normal, and a distance to move the plane along the normal. More...
	MovablePlane (const Vector3 &rkPoint0, const Vector3 &rkPoint1, const Vector3 &rkPoint2)
	~MovablePlane ()
const Plane &	_getDerivedPlane (void) const
	Get the derived plane as transformed by its parent node. More...
void	_notifyCurrentCamera (Camera *)
	Overridden from MovableObject. More...
void	_updateRenderQueue (RenderQueue *)
	Overridden from MovableObject. More...
const AxisAlignedBox &	getBoundingBox (void) const
	Overridden from MovableObject. More...
Real	getBoundingRadius (void) const
	Overridden from MovableObject. More...
const String &	getMovableType (void) const
	Overridden from MovableObject. 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::Plane
	Plane ()
	Default constructor - sets everything to 0. More...
	Plane (const Vector3 &p0, const Vector3 &p1, const Vector3 &p2)
	Plane (const Vector3 &rkNormal, const Vector3 &rkPoint)
	Plane (const Vector3 &rkNormal, Real fConstant)
	Construct a plane through a normal, and a distance to move the plane along the normal. More...
	Plane (const Vector4 &v)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
	Plane (Real a, Real b, Real c, Real _d)
	Construct a plane using the 4 constants directly. More...
Real	getDistance (const Vector3 &rkPoint) const
	This is a pseudodistance. More...
Side	getSide (const AxisAlignedBox &box) const
	Returns the side where the alignedBox is. More...
Side	getSide (const Vector3 &centre, const Vector3 &halfSize) const
	Returns which side of the plane that the given box lies on. More...
Side	getSide (const Vector3 &rkPoint) const
Real	normalise (void)
	Normalises the plane. More...
bool	operator!= (const Plane &rhs) const
Plane	operator- () const
	Get flipped plane, with same location but reverted orientation. More...
bool	operator== (const Plane &rhs) const
	Comparison operator. More...
Vector3	projectVector (const Vector3 &v) const
	Project a vector onto the plane. More...
void	redefine (const Vector3 &p0, const Vector3 &p1, const Vector3 &p2)
	Redefine this plane based on 3 points. More...
void	redefine (const Vector3 &rkNormal, const Vector3 &rkPoint)
	Redefine this plane based on a normal and a point. 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	_notifyAttached (Node *parent, bool isTagPoint=false)
	Internal method called to notify the object that it has been attached to a node. More...
virtual void	_notifyCreator (MovableObjectFactory *fact)
	Notify the object of it's creator (internal use only) More...
virtual void	_notifyManager (SceneManager *man)
	Notify the object of it's manager (internal use only) More...
virtual void	_notifyMoved (void)
	Internal method called to notify the object that it has been 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	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...
Real	getBoundingRadiusScaled () const
	as getBoundingRadius, but with scaling applied More...
bool	getCastShadows (void) const
	Returns whether shadow casting is enabled for this object. More...
const AxisAlignedBox &	getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const override
	Gets the world space bounding box of the dark cap, as extruded using the light provided. More...
EdgeData *	getEdgeList (void)
	Returns details of the edges which might be used to determine a silhouette. More...
const AxisAlignedBox &	getLightCapBounds (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...
Listener *	getListener (void) const
	Gets the current listener for this object. More...
const String &	getName (void) const
	Returns the name of this object. 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...
virtual 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 ShadowRenderableList &	getShadowVolumeRenderableList (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 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...
virtual 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	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 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	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 StringVector &	getAnimableValueNames (void) const
	Gets a list of animable value names for this object. More...

Additional Inherited Members
Public Types inherited from Ogre::Plane
enum	Side { NO_SIDE, POSITIVE_SIDE, NEGATIVE_SIDE, BOTH_SIDE }
	The "positive side" of the plane is the half space to which the plane normal points. More...
Public Types inherited from Ogre::ShadowCaster
typedef std::vector< ShadowRenderable * >	ShadowRenderableList
typedef VectorIterator< ShadowRenderableList >	ShadowRenderableListIterator
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...
Public Attributes inherited from Ogre::Plane
Real	d
Vector3	normal

Detailed Description

Definition of a Plane that may be attached to a node, and the derived details of it retrieved simply.

Remarks

This plane is not here for rendering purposes, it's to allow you to attach planes to the scene in order to have them move and follow nodes on their own, which is useful if you're using the plane for some kind of calculation, e.g. reflection.

Constructor & Destructor Documentation

MovablePlane() [1/5]

Ogre::MovablePlane::MovablePlane

(

const String &

name

)

MovablePlane() [2/5]

Ogre::MovablePlane::MovablePlane

(

const Plane &

rhs

)

MovablePlane() [3/5]

Ogre::MovablePlane::MovablePlane	(	const Vector3 &	rkNormal,
		Real	fConstant
	)

Construct a plane through a normal, and a distance to move the plane along the normal.

MovablePlane() [4/5]

Ogre::MovablePlane::MovablePlane	(	const Vector3 &	rkNormal,
		const Vector3 &	rkPoint
	)

MovablePlane() [5/5]

Ogre::MovablePlane::MovablePlane	(	const Vector3 &	rkPoint0,
		const Vector3 &	rkPoint1,
		const Vector3 &	rkPoint2
	)

~MovablePlane()

Ogre::MovablePlane::~MovablePlane ( )

inline

Member Function Documentation

_notifyCurrentCamera()

void Ogre::MovablePlane::_notifyCurrentCamera ( Camera *  )

inlinevirtual

Overridden from MovableObject.

Reimplemented from Ogre::MovableObject.

getBoundingBox()

const AxisAlignedBox& Ogre::MovablePlane::getBoundingBox ( void  ) const

inlinevirtual

Overridden from MovableObject.

Implements Ogre::MovableObject.

References Ogre::AxisAlignedBox::BOX_NULL.

getBoundingRadius()

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

inlinevirtual

Overridden from MovableObject.

Implements Ogre::MovableObject.

_updateRenderQueue()

void Ogre::MovablePlane::_updateRenderQueue ( RenderQueue *  )

inlinevirtual

Overridden from MovableObject.

Implements Ogre::MovableObject.

getMovableType()

const String& Ogre::MovablePlane::getMovableType ( void  ) const

virtual

Overridden from MovableObject.

Implements Ogre::MovableObject.

_getDerivedPlane()

const Plane& Ogre::MovablePlane::_getDerivedPlane

(

void

)

const

Get the derived plane as transformed by its parent node.

visitRenderables()

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

inlinevirtual

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.

---

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

• OgreMovablePlane.h