OGRE-Next  3.0.0
Object-Oriented Graphics Rendering Engine
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. More...
 
 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. More...
 
void _updateRenderQueue (RenderQueue *, Camera *, const Camera *) override
 Overridden from MovableObject. More...
 
const AxisAlignedBoxgetBoundingBox () const
 Overridden from MovableObject. More...
 
const StringgetMovableType () const override
 Overridden from MovableObject. 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 (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 &rkBox) 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 ()
 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 (IdType id, ObjectMemoryManager *objectMemoryManager, SceneManager *manager, uint8 renderQueueId)
 Constructor. More...
 
 MovableObject (ObjectData *objectDataPtrs)
 Don't use this constructor unless you know what you're doing. More...
 
virtual ~MovableObject ()
 Virtual destructor - read Scott Meyers if you don't know why this is needed. More...
 
LightList_getLightList ()
 Returns a pointer to the current list of lights for this object. More...
 
SceneManager_getManager () const
 Get the manager of this object, if any (internal use only) More...
 
ObjectData_getObjectData ()
 Returns a direct access to the ObjectData state. More...
 
const Matrix4_getParentNodeFullTransform () const
 Returns the full transformation of the parent sceneNode or the attachingPoint node. More...
 
virtual void _notifyAttached (Node *parent)
 Internal method called to notify the object that it has been attached to a node. More...
 
void _notifyManager (SceneManager *man)
 Notify the object of it's manager (internal use only) More...
 
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. 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 ()
 Detaches an object from a parent SceneNode if attached. More...
 
RealAsUint getCachedDistanceToCamera () const
 Returns the distance to camera as calculated in cullFrustum() More...
 
Real getCachedDistanceToCameraAsReal () const
 Returns the distance to camera as calculated in cullFrustum() More...
 
bool getCastShadows () const
 Returns whether shadow casting is enabled for this object. More...
 
unsigned char getCurrentMeshLod () const
 
uint32 getLightMask () const
 Get a bitwise mask which will filter the lights affecting this object. More...
 
ListenergetListener () const
 Gets the current listener for this object. More...
 
Aabb getLocalAabb () const
 Retrieves the local axis-aligned bounding box for this object. More...
 
float getLocalRadius () const
 See getLocalAabb and getWorldRadius. More...
 
const StringgetName () const
 Returns the name of this object. More...
 
NodegetParentNode () const
 Returns the node to which this object is attached. More...
 
SceneNodegetParentSceneNode () const
 
uint32 getQueryFlags () const
 Returns the query flags relevant for this object. More...
 
Real getRenderingDistance () 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 () const
 Gets the queue group for this entity, see setRenderQueueGroup for full details. More...
 
Real getShadowRenderingDistance () const
 Gets the distance at which batches are no longer casting shadows. More...
 
SkeletonInstancegetSkeletonInstance () 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 () const
 Returns the visibility flags relevant for this object. More...
 
bool getVisible () const
 Gets this object whether to be visible or not, if it has a renderable component. More...
 
Aabb getWorldAabb () const
 Gets the axis aligned box in world space. More...
 
Aabb getWorldAabbUpdated ()
 Gets the axis aligned box in world space. More...
 
float getWorldRadius () const
 Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). More...
 
float getWorldRadiusUpdated ()
 Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). More...
 
virtual void instanceBatchCullFrustumThreaded (const Frustum *frustum, const Camera *lodCamera, uint32 combinedVisibilityFlags)
 
bool isAttached () const
 Returns true if this object is attached to a Node. More...
 
bool isStatic () const
 Checks whether this MovableObject is static. More...
 
bool isVisible () const
 Returns whether or not this object is supposed to be visible or not. More...
 
const LightListqueryLights () 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 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 setLocalAabb (const Aabb box)
 Sets the local axis-aligned bounding box for this object. More...
 
void setName (const String &name)
 Sets a custom name for this node. 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...
 
void setShadowRenderingDistance (Real dist)
 Sets the distance at which the object is no longer casting shadows. More...
 
bool setStatic (bool bStatic)
 Turns this Node into static or dynamic. More...
 
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::AnimableObject
 AnimableObject ()
 
virtual ~AnimableObject ()
 
virtual AnimableValuePtr createAnimableValue (const String &valueName)
 Create a reference-counted AnimableValuePtr for the named value. More...
 
const StringVectorgetAnimableValueNames () const
 Gets a list of animable value names for this object. More...
 
- Public Member Functions inherited from Ogre::IdObject
 IdObject (IdType id)
 We don't call generateNewId() here, to prevent objects in the stack (i.e. More...
 
IdType getId () const
 Get the unique id of this object. More...
 
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. More...
 
static uint32 getDefaultLightMask ()
 Get the default light mask for all future MovableObject instances. 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 setDefaultLightMask (uint32 mask)
 Set the default light mask 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 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). More...
 
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). More...
 
RenderableArray mRenderables
 
- Static Public Attributes inherited from Ogre::MovableObject
static const FastArray< Realc_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: