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 (IdType id, ObjectMemoryManager *objectMemoryManager, SceneManager *manager)
	MovablePlane (IdType id, ObjectMemoryManager *objectMemoryManager, SceneManager *manager, const Plane &rhs)
	MovablePlane (IdType id, ObjectMemoryManager *objectMemoryManager, SceneManager *manager, const Vector3 &rkNormal, const Vector3 &rkPoint)
	MovablePlane (IdType id, ObjectMemoryManager *objectMemoryManager, SceneManager *manager, const Vector3 &rkNormal, Real fConstant)
	Construct a plane through a normal, and a distance to move the plane along the normal.
	MovablePlane (IdType id, ObjectMemoryManager *objectMemoryManager, SceneManager *manager, const Vector3 &rkPoint0, const Vector3 &rkPoint1, const Vector3 &rkPoint2)
	~MovablePlane () override
const Plane &	_getDerivedPlane () const
	Get the derived plane as transformed by its parent node.
void	_updateRenderQueue (RenderQueue *, Camera *, const Camera *) override
	Overridden from MovableObject.
const AxisAlignedBox &	getBoundingBox () const
	Overridden from MovableObject.
const String &	getMovableType () const override
	Overridden from MovableObject.
Public Member Functions inherited from Ogre::Plane
	Plane ()
	Default constructor - sets everything to 0.
	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.
	Plane (Real a, Real b, Real c, Real _d)
	Construct a plane using the 4 constants directly.
Real	getDistance (const Vector3 &rkPoint) const
	This is a pseudodistance.
Side	getSide (const AxisAlignedBox &rkBox) const
	Returns the side where the alignedBox is.
Side	getSide (const Vector3 &centre, const Vector3 &halfSize) const
	Returns which side of the plane that the given box lies on.
Side	getSide (const Vector3 &rkPoint) const
Real	normalise ()
	Normalises the plane.
bool	operator!= (const Plane &rhs) const
Plane	operator- () const
	Get flipped plane, with same location but reverted orientation.
bool	operator== (const Plane &rhs) const
	Comparison operator.
Vector3	projectVector (const Vector3 &v) const
	Project a vector onto the plane.
void	redefine (const Vector3 &p0, const Vector3 &p1, const Vector3 &p2)
	Redefine this plane based on 3 points.
void	redefine (const Vector3 &rkNormal, const Vector3 &rkPoint)
	Redefine this plane based on a normal and a point.
Public Member Functions inherited from Ogre::MovableObject
	MovableObject (IdType id, ObjectMemoryManager *objectMemoryManager, SceneManager *manager, uint8 renderQueueId)
	Constructor.
	MovableObject (ObjectData *objectDataPtrs)
	Don't use this constructor unless you know what you're doing.
virtual	~MovableObject ()
	Virtual destructor - read Scott Meyers if you don't know why this is needed.
LightList *	_getLightList ()
	Returns a pointer to the current list of lights for this object.
SceneManager *	_getManager () const
	Get the manager of this object, if any (internal use only)
ObjectData &	_getObjectData ()
	Returns a direct access to the ObjectData state.
const Matrix4 &	_getParentNodeFullTransform () const
	Returns the full transformation of the parent sceneNode or the attachingPoint node.
virtual void	_notifyAttached (Node *parent)
	Internal method called to notify the object that it has been attached to a node.
void	_notifyManager (SceneManager *man)
	Notify the object of it's manager (internal use only)
virtual void	_notifyParentNodeMemoryChanged ()
virtual void	_notifyStaticDirty () const
	Called by SceneManager when it is telling we're a static MovableObject being dirty Don't call this directly.
virtual void	_releaseManualHardwareResources ()
	Notifies the movable object that hardware resources were lost.
virtual void	_restoreManualHardwareResources ()
	Notifies the movable object that hardware resources should be restored.
void	addQueryFlags (uint32 flags)
	As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.
void	addVisibilityFlags (uint32 flags)
	As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.
void	detachFromParent ()
	Detaches an object from a parent SceneNode if attached.
RealAsUint	getCachedDistanceToCamera () const
	Returns the distance to camera as calculated in cullFrustum()
Real	getCachedDistanceToCameraAsReal () const
	Returns the distance to camera as calculated in cullFrustum()
bool	getCastShadows () const
	Returns whether shadow casting is enabled for this object.
unsigned char	getCurrentMeshLod () const
uint32	getLightMask () const
	Get a bitwise mask which will filter the lights affecting this object.
Listener *	getListener () const
	Gets the current listener for this object.
Aabb	getLocalAabb () const
	Retrieves the local axis-aligned bounding box for this object.
float	getLocalRadius () const
	See getLocalAabb and getWorldRadius.
const String &	getName () const
	Returns the name of this object.
Node *	getParentNode () const
	Returns the node to which this object is attached.
SceneNode *	getParentSceneNode () const
uint32	getQueryFlags () const
	Returns the query flags relevant for this object.
Real	getRenderingDistance () const
	Gets the distance at which batches are no longer rendered.
Real	getRenderingMinPixelSize () const
	Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.
uint8	getRenderQueueGroup () const
	Gets the queue group for this entity, see setRenderQueueGroup for full details.
Real	getShadowRenderingDistance () const
	Gets the distance at which batches are no longer casting shadows.
SkeletonInstance *	getSkeletonInstance () const
UserObjectBindings &	getUserObjectBindings ()
	Return an instance of user objects binding associated with this class.
const UserObjectBindings &	getUserObjectBindings () const
	Return an instance of user objects binding associated with this class.
uint32	getVisibilityFlags () const
	Returns the visibility flags relevant for this object.
bool	getVisible () const
	Gets this object whether to be visible or not, if it has a renderable component.
Aabb	getWorldAabb () const
	Gets the axis aligned box in world space.
Aabb	getWorldAabbUpdated ()
	Gets the axis aligned box in world space.
float	getWorldRadius () const
	Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).
float	getWorldRadiusUpdated ()
	Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).
virtual void	instanceBatchCullFrustumThreaded (const Frustum *frustum, const Camera *lodCamera, uint32 combinedVisibilityFlags)
bool	isAttached () const
	Returns true if this object is attached to a Node.
bool	isStatic () const
	Checks whether this MovableObject is static.
bool	isVisible () const
	Returns whether or not this object is supposed to be visible or not.
const LightList &	queryLights () const
	Gets a list of lights, ordered relative to how close they are to this movable object.
void	removeQueryFlags (uint32 flags)
	As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.
void	removeVisibilityFlags (uint32 flags)
	As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.
void	setCastShadows (bool enabled)
	Sets whether or not this object will cast shadows.
void	setLightMask (uint32 lightMask)
	Set a bitwise mask which will filter the lights affecting this object.
void	setListener (Listener *listener)
	Sets a listener for this object.
void	setLocalAabb (const Aabb box)
	Sets the local axis-aligned bounding box for this object.
void	setName (const String &name)
	Sets a custom name for this node.
void	setQueryFlags (uint32 flags)
	Sets the query flags for this object.
void	setRenderingDistance (Real dist)
	Sets the distance at which the object is no longer rendered.
void	setRenderingMinPixelSize (Real pixelSize)
	Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.
virtual void	setRenderQueueGroup (uint8 queueID)
	Sets the render queue group this entity will be rendered through.
void	setShadowRenderingDistance (Real dist)
	Sets the distance at which the object is no longer casting shadows.
bool	setStatic (bool bStatic)
	Turns this Node into static or dynamic.
void	setVisibilityFlags (uint32 flags)
	Sets the visibility flags for this object.
void	setVisible (bool visible)
	Tells this object whether to be visible or not, if it has a renderable component.
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.
const StringVector &	getAnimableValueNames () const
	Gets a list of animable value names for this object.
Public Member Functions inherited from Ogre::IdObject
	IdObject (IdType id)
	We don't call generateNewId() here, to prevent objects in the stack (i.e.
IdType	getId () const
	Get the unique id of this object.
bool	operator() (const IdObject &left, const IdObject &right)
bool	operator() (const IdObject *left, const IdObject *right)

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::MovableObject
typedef FastArray< MovableObject * >	MovableObjectArray
Static Public Member Functions inherited from Ogre::MovableObject
static void	buildLightList (const size_t numNodes, ObjectData t, const LightListInfo &globalLightList)
static void	calculateCastersBox (const size_t numNodes, ObjectData t, uint32 sceneVisibilityFlags, AxisAlignedBox *outBox)
static void	cullFrustum (const size_t numNodes, ObjectData t, const Camera *frustum, uint32 sceneVisibilityFlags, MovableObjectArray &outCulledObjects, const Camera *lodCamera)
static void	cullLights (const size_t numNodes, ObjectData t, uint32 sceneLightMask, LightListInfo &outGlobalLightList, const FrustumVec &frustums, const FrustumVec &cubemapFrustums)
	See SceneManager::cullLights & see MovableObject::cullFrustum.
static uint32	getDefaultLightMask ()
	Get the default light mask for all future MovableObject instances.
static uint32	getDefaultQueryFlags ()
	Get the default query flags for all future MovableObject instances.
static uint32	getDefaultVisibilityFlags ()
	Get the default visibility flags for all future MovableObject instances.
static void	setDefaultLightMask (uint32 mask)
	Set the default light mask for all future MovableObject instances.
static void	setDefaultQueryFlags (uint32 flags)
	Set the default query flags for all future MovableObject instances.
static void	setDefaultVisibilityFlags (uint32 flags)
	Set the default visibility flags for all future MovableObject instances.
static void	updateAllBounds (const size_t numNodes, ObjectData t)
Public Attributes inherited from Ogre::Plane
Real	d
Vector3	normal
Public Attributes inherited from Ogre::MovableObject
size_t	mGlobalIndex
	Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).
size_t	mParentIndex
	Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).
RenderableArray	mRenderables
Static Public Attributes inherited from Ogre::MovableObject
static const FastArray< Real >	c_DefaultLodMesh

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	(	IdType	id,
		ObjectMemoryManager *	objectMemoryManager,
		SceneManager *	manager
	)

MovablePlane() [2/5]

Ogre::MovablePlane::MovablePlane	(	IdType	id,
		ObjectMemoryManager *	objectMemoryManager,
		SceneManager *	manager,
		const Plane &	rhs
	)

MovablePlane() [3/5]

Ogre::MovablePlane::MovablePlane	(	IdType	id,
		ObjectMemoryManager *	objectMemoryManager,
		SceneManager *	manager,
		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	(	IdType	id,
		ObjectMemoryManager *	objectMemoryManager,
		SceneManager *	manager,
		const Vector3 &	rkNormal,
		const Vector3 &	rkPoint
	)

MovablePlane() [5/5]

Ogre::MovablePlane::MovablePlane	(	IdType	id,
		ObjectMemoryManager *	objectMemoryManager,
		SceneManager *	manager,
		const Vector3 &	rkPoint0,
		const Vector3 &	rkPoint1,
		const Vector3 &	rkPoint2
	)

~MovablePlane()

Ogre::MovablePlane::~MovablePlane ( )

inlineoverride

Member Function Documentation

_getDerivedPlane()

const Plane & Ogre::MovablePlane::_getDerivedPlane

(

)

const

Get the derived plane as transformed by its parent node.

_updateRenderQueue()

void Ogre::MovablePlane::_updateRenderQueue ( RenderQueue *  , Camera *  , const Camera *    )

inlineoverridevirtual

Overridden from MovableObject.

Reimplemented from Ogre::MovableObject.

getBoundingBox()

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

inline

Overridden from MovableObject.

getMovableType()

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

overridevirtual

Overridden from MovableObject.

Implements Ogre::MovableObject.

---

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

• OgreMovablePlane.h