A frustum represents a pyramid, capped at the near and far end which is used to represent either a visible area or a projection area. More...

#include <OgreFrustum.h>

Inheritance diagram for Ogre::Frustum:

Public Types
typedef map< size_t, Vector4 >::type	CustomParameterMap

typedef FastArray< MovableObject * >	MovableObjectArray
	@See SceneManager::cullFrustum

Public Member Functions
	Frustum (IdType id, ObjectMemoryManager *objectMemoryManager)
	Named constructor.

virtual	~Frustum ()

const Plane *	_getCachedFrustumPlanes (void) const
	Returns the frustum planes, doesn't check if dirty.

const Vector3 *	_getCachedWorldSpaceCorners (void) const

LightList *	_getLightList ()
	Returns a pointer to the current list of lights for this object.

SceneManager *	_getManager (void) 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 (void) 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 (void)
	@See Node::_callMemoryChangeListeners

virtual void	_notifyStaticDirty (void) 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.

virtual void	_setHlmsHashes (uint32 hash, uint32 casterHash)
	Manually sets the hlms hashes. Don't call this directly.

virtual void	_setNullDatablock (void)
	Sets the datablock to a null pointer.

virtual void	_updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
	Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.

virtual void	_updateRenderQueue (RenderQueue queue, Camera camera, const Camera *lodCamera)
	Internal method by which the movable object must add Renderable subclass instances to the rendering queue.

void	addPoseWeight (size_t index, float w)

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.

virtual void	calcViewMatrixRelative (const Vector3 &relPos, Matrix4 &matToUpdate) const
	Calculate a view matrix for this frustum, relative to a potentially dynamic point.

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

void	detachFromParent (void)
	Detaches an object from a parent SceneNode if attached.

virtual void	disableCustomNearClipPlane (void)
	Disables any custom near clip plane.

virtual void	disableReflection (void)
	Disables reflection modification previously turned on with enableReflection.

virtual void	enableCustomNearClipPlane (const MovablePlane *plane)
	Links the frustum to a custom near clip plane, which can be used to clip geometry in a custom manner without using user clip planes.

virtual void	enableCustomNearClipPlane (const Plane &plane)
	Links the frustum to a custom near clip plane, which can be used to clip geometry in a custom manner without using user clip planes.

virtual void	enableReflection (const MovablePlane *p)
	Modifies this frustum so it always renders from the reflection of itself through the plane specified.

virtual void	enableReflection (const Plane &p)
	Modifies this frustum so it always renders from the reflection of itself through the plane specified.

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

virtual Real	getAspectRatio (void) const
	Retrieves the current aspect ratio.

const AxisAlignedBox &	getBoundingBox (void) const
	Overridden from MovableObject.

RealAsUint	getCachedDistanceToCamera (void) const
	Returns the distance to camera as calculated in @cullFrustum.

Real	getCachedDistanceToCameraAsReal (void) const
	Returns the distance to camera as calculated in @cullFrustum.

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

virtual bool	getCastsShadows (void) const
	Method which reports whether this renderable would normally cast a shadow.

uint8	getCurrentMaterialLod (void) const

unsigned char	getCurrentMeshLod (void) const

const Vector4 &	getCustomParameter (size_t index) const
	Gets the custom value associated with this Renderable at the given index.

const CustomParameterMap &	getCustomParameters (void) const

void	getCustomWorldSpaceCorners (ArrayVector3 outCorners[(8+ARRAY_PACKED_REALS - 1)/ARRAY_PACKED_REALS], Real customFarPlane) const

HlmsDatablock *	getDatablock (void) const

virtual Real	getFarClipDistance (void) const
	Retrieves the distance from the frustum to the far clipping plane.

virtual Real	getFocalLength () const
	Returns focal length of frustum.

virtual const Radian &	getFOVy (void) const
	Retrieves the frustums Y-dimension Field Of View (FOV).

virtual void	getFrustumExtents (Real &outleft, Real &outright, Real &outtop, Real &outbottom, FrustrumExtentsType frustrumExtentsType=FET_PROJ_PLANE_POS) const
	Get the extents of the frustum in view space.

virtual const Vector2 &	getFrustumOffset () const
	Retrieves the frustum offsets.

const Plane &	getFrustumPlane (unsigned short plane) const
	Retrieves a specified plane of the frustum (world space).

const Plane *	getFrustumPlanes (void) const
	Retrieves the clipping planes of the frustum (world space).

uint32	getHlmsCasterHash (void) const

uint32	getHlmsHash (void) const

IdType	getId () const
	Get the unique id of this object.

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

const LightList &	getLights (void) const
	Overridden from Renderable.

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

Aabb	getLocalAabb (void) const
	Retrieves the local axis-aligned bounding box for this object.

float	getLocalRadius (void) const
	See getLocalAabb and getWorldRadius.

MaterialPtr	getMaterial (void) const
	Retrieves the material this renderable object uses.

const String &	getMovableType (void) const
	Overridden from MovableObject.

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

virtual Real	getNearClipDistance (void) const
	Sets the position of the near clipping plane.

unsigned short	getNumPoses (void) const

virtual unsigned short	getNumWorldTransforms (void) const
	Returns the number of world transform matrices this renderable requires.

virtual const Quaternion &	getOrientationForViewUpdate (void) const
	Get the derived orientation of this frustum.

OrientationMode	getOrientationMode () const
	Get the orientation mode of the frustum.

virtual Real	getOrthoWindowHeight () const
	Gets the orthographic window height, for use with orthographic rendering only.

virtual Real	getOrthoWindowWidth () const
	Gets the orthographic window width, for use with orthographic rendering only.

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

SceneNode *	getParentSceneNode (void) const

PlaneBoundedVolume	getPlaneBoundedVolume ()
	Gets a world-space list of planes enclosing the frustum.

virtual bool	getPolygonModeOverrideable (void) const
	Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

bool	getPoseHalfPrecision () const

bool	getPoseNormals () const

TexBufferPacked *	getPoseTexBuffer () const

float	getPoseWeight (size_t index) const

float *	getPoseWeights () const

virtual const Vector3 &	getPositionForViewUpdate (void) const
	Get the derived position of this frustum.

virtual const Matrix4 &	getProjectionMatrix (void) const
	Gets the normal projection matrix for this frustum, ie the projection matrix which conforms to standard right-handed rules and uses depth range [-1,+1].

virtual const Matrix4 &	getProjectionMatrixRS (void) const
	Gets the projection matrix for this frustum adjusted for the current rendersystem specifics (may be right or left-handed, depth range may vary).

virtual const Matrix4 &	getProjectionMatrixWithRSDepth (void) const
	Gets the depth-adjusted projection matrix for the current rendersystem, but one which still conforms to right-hand rules.

virtual ProjectionType	getProjectionType (void) const
	Retrieves info on the type of projection used (orthographic or perspective).

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

virtual const Matrix4 &	getReflectionMatrix (void) const
	Returns the reflection matrix of the frustum if appropriate.

virtual const Plane &	getReflectionPlane (void) const
	Returns the reflection plane of the frustum if appropriate.

Real	getRenderingDistance (void) 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.

void	getRenderOperation (v1::RenderOperation &op, bool casterPass)
	Overridden from Renderable.

uint8	getRenderQueueGroup (void) const
	Gets the queue group for this entity, see setRenderQueueGroup for full details.

uint8	getRenderQueueSubGroup (void) const

Real	getShadowRenderingDistance (void) const
	Gets the distance at which batches are no longer casting shadows.

SkeletonInstance *	getSkeletonInstance (void) const

Real	getSquaredViewDepth (const Camera *cam) const
	Overridden from Renderable.

bool	getUseIdentityProjection (void) const
	Returns whether or not to use an 'identity' projection.

bool	getUseIdentityView (void) const
	Returns whether or not to use an 'identity' view.

virtual bool	getUseIdentityViewProjMatrixIsDynamic (void) const
	Returns whether the Hlms implementation should evaluate getUseIdentityProjection per object at runtime, or if it can assume the Renderable will remain with the same setting until the datablock is flushed (performance optimization)

virtual bool	getUseIdentityWorldMatrix (void) const
	Returns whether the world matrix is an identity matrix.

virtual OGRE_DEPRECATED const Any &	getUserAny (void) const

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

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.

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

const VertexArrayObjectArray &	getVaos (VertexPass vertexPass) const

virtual const Matrix4 &	getViewMatrix (void) const
	Gets the view matrix for this frustum.

uint32	getVisibilityFlags (void) const
	Returns the visibility flags relevant for this object.

bool	getVisible (void) 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 const Vector3 *	getWorldSpaceCorners (void) const
	Gets the world space corners of the frustum.

void	getWorldTransforms (Matrix4 *xform) const
	Overridden from Renderable.

bool	hasCustomParameter (size_t index) const
	Checks whether a custom value is associated with this Renderable at the given index.

bool	hasSkeletonAnimation (void) const

virtual void	instanceBatchCullFrustumThreaded (const Frustum frustum, const Camera lodCamera, uint32 combinedVisibilityFlags)
	@See InstancingTheadedCullingMethod,

bool	isAttached (void) const
	Returns true if this object is attached to a Node.

virtual bool	isCustomNearClipPlaneEnabled (void) const
	Is a custom near clip plane in use?

virtual bool	isCustomProjectionMatrixEnabled (void) const
	Returns whether a custom projection matrix is in use.

virtual bool	isCustomViewMatrixEnabled (void) const
	Returns whether a custom view matrix is in use.

virtual bool	isReflected (void) const
	Returns whether this frustum is being reflected.

bool	isStatic () const
	Checks whether this MovableObject is static. @See setStatic.

virtual bool	isVisible (const AxisAlignedBox &bound, FrustumPlane *culledBy=0) const
	Tests whether the given container is visible in the Frustum.

virtual bool	isVisible (const Sphere &bound, FrustumPlane *culledBy=0) const
	Tests whether the given container is visible in the Frustum.

virtual bool	isVisible (const Vector3 &vert, FrustumPlane *culledBy=0) const
	Tests whether the given vertex is visible in the Frustum.

bool	isVisible (void) const
	Returns whether or not this object is supposed to be visible or not.

void	operator delete (void *ptr)

void	operator delete (void ptr, const char , int, const char *)

void	operator delete (void ptr, void )

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, const char , int, const char *)

void *	operator new (size_t sz)

void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info

void *	operator new (size_t sz, void *ptr)
	placement operator new

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info

bool	operator() (const IdObject &left, const IdObject &right)

bool	operator() (const IdObject left, const IdObject right)

virtual void	postRender (SceneManager sm, RenderSystem rsys)
	Called immediately after the Renderable has been rendered.

virtual bool	preRender (SceneManager sm, RenderSystem rsys)
	Called just prior to the Renderable being rendered.

virtual bool	projectSphere (const Sphere &sphere, Real left, Real top, Real right, Real bottom) const
	Project a sphere onto the near plane and get the bounding rectangle.

const LightList &	queryLights (void) const
	Gets a list of lights, ordered relative to how close they are to this movable object.

void	removeCustomParameter (size_t index)
	Removes a custom value which is associated with this Renderable at the given index.

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.

virtual void	resetFrustumExtents ()
	Reset the frustum extents to be automatically derived from other params.

virtual void	setAspectRatio (Real ratio)
	Sets the aspect ratio for the frustum viewport.

void	setCastShadows (bool enabled)
	Sets whether or not this object will cast shadows.

void	setCustomParameter (size_t index, const Vector4 &value)
	Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.

virtual void	setCustomProjectionMatrix (bool enable, const Matrix4 &projectionMatrix=Matrix4::IDENTITY, bool alternateDepthRange=false)
	Set whether to use a custom projection matrix on this frustum.

virtual void	setCustomViewMatrix (bool enable, const Matrix4 &viewMatrix=Matrix4::IDENTITY)
	Set whether to use a custom view matrix on this frustum.

virtual void	setDatablock (HlmsDatablock *datablock)
	Assigns a datablock (i.e. HLMS Material) to this renderable.

void	setDatablock (IdString datablockName)
	Assigns a datablock (i.e.

void	setDatablockOrMaterialName (String materialName, String groupName)
	First tries to see if an HLMS datablock exist with the given name, if not, tries to search among low level materials.

virtual void	setFarClipDistance (Real farDist)
	Sets the distance to the far clipping plane.

virtual void	setFocalLength (Real focalLength=1.0)
	Sets frustum focal length (used in stereo rendering).

virtual void	setFOVy (const Radian &fovy)
	Sets the Y-dimension Field Of View (FOV) of the frustum.

virtual void	setFrustumExtents (Real left, Real right, Real top, Real bottom, FrustrumExtentsType frustrumExtentsType=FET_PROJ_PLANE_POS)
	Manually set the extents of the frustum.

virtual void	setFrustumOffset (const Vector2 &offset)
	Sets frustum offsets, used in stereo rendering.

virtual void	setFrustumOffset (Real horizontal=0.0, Real vertical=0.0)
	Sets frustum offsets, used in stereo rendering.

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.

virtual void	setMaterial (const MaterialPtr &material)
	Sets the given material. Overrides HLMS materials.

void	setMaterialName (const String &name, const String &groupName)
	Sets the name of the Material to be used. Prefer using HLMS @See setHlms.

void	setName (const String &name)
	Sets a custom name for this node.

virtual void	setNearClipDistance (Real nearDist)
	Sets the position of the near clipping plane.

void	setOrientationMode (OrientationMode orientationMode)
	Set the orientation mode of the frustum.

virtual void	setOrthoWindow (Real w, Real h)
	Sets the orthographic window settings, for use with orthographic rendering only.

virtual void	setOrthoWindowHeight (Real h)
	Sets the orthographic window height, for use with orthographic rendering only.

virtual void	setOrthoWindowWidth (Real w)
	Sets the orthographic window width, for use with orthographic rendering only.

virtual void	setPolygonModeOverrideable (bool override)
	Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

void	setPoseWeight (size_t index, float w)

virtual void	setProjectionType (ProjectionType pt)
	Sets the type of projection to use (orthographic or perspective).

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	setRenderQueueSubGroup (uint8 subGroup)
	Sets the render queue sub group.

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	setUseIdentityProjection (bool useIdentityProjection)
	Sets whether or not to use an 'identity' projection.

void	setUseIdentityView (bool useIdentityView)
	Sets whether or not to use an 'identity' view.

virtual OGRE_DEPRECATED void	setUserAny (const Any &anything)

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.

Static Public Member Functions
static void	buildLightList (const size_t numNodes, ObjectData t, const LightListInfo &globalLightList)
	@See SceneManager::buildLightList

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, LightListInfo &outGlobalLightList, const FrustumVec &frustums, const FrustumVec &cubemapFrustums)
	@See SceneManager::cullLights &

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	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)
	@See SceneManager::updateAllBounds

Public Attributes
uint8	mCustomParameter
	Only valid when using low level materials.

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

uint32	mHlmsGlobalIndex
	Index in the vector holding this Rendrable reference in the HLMS datablock.

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
static const FastArray< Real >	c_DefaultLodMesh

static const Real	INFINITE_FAR_PLANE_ADJUST
	Small constant used to reduce far plane projection to avoid inaccuracies.

Detailed Description

A frustum represents a pyramid, capped at the near and far end which is used to represent either a visible area or a projection area.

Can be used for a number of applications.

Member Typedef Documentation

◆ CustomParameterMap

typedef map<size_t,Vector4>::type Ogre::Renderable::CustomParameterMap

inherited

◆ MovableObjectArray

typedef FastArray<MovableObject*> Ogre::MovableObject::MovableObjectArray

inherited

@See SceneManager::cullFrustum

Remarks: We don't pass by reference on purpose (avoid implicit aliasing) We perform frustum culling AND test visibility mask at the same time

Parameters

frustum	Frustum to clip against
sceneVisibilityFlags	Combined scene's visibility flags (i.e. viewport \| scene). Set LAYER_SHADOW_CASTER bit if you want to exclude non-shadow casters.
outCulledObjects	Out. List of objects that are (fully or partially) inside the frustum and should be rendered
lodCamera	Camera in which lod levels calculations are based (i.e. during shadow pass renders) Note however, we only use this camera to calulate if should be visible according to mUpperDistance

Constructor & Destructor Documentation

◆ Frustum()

Ogre::Frustum::Frustum	(	IdType	id,
		ObjectMemoryManager *	objectMemoryManager
	)

Named constructor.

◆ ~Frustum()

virtual Ogre::Frustum::~Frustum ( )

virtual

Member Function Documentation

◆ _getCachedFrustumPlanes()

const Plane * Ogre::Frustum::_getCachedFrustumPlanes ( void ) const

inline

Returns the frustum planes, doesn't check if dirty.

◆ _getCachedWorldSpaceCorners()

const Vector3 * Ogre::Frustum::_getCachedWorldSpaceCorners ( void ) const

inline

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

◆ _getManager()

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

inlineinherited

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

◆ _getObjectData()

ObjectData & Ogre::MovableObject::_getObjectData ( )

inlineinherited

Returns a direct access to the ObjectData state.

◆ _getParentNodeFullTransform()

const Matrix4 & Ogre::MovableObject::_getParentNodeFullTransform ( void ) const

inherited

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

◆ _notifyAttached()

virtual void Ogre::MovableObject::_notifyAttached ( Node * parent )

virtualinherited

Internal method called to notify the object that it has been attached to a node.

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

◆ _notifyManager()

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

inlineinherited

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

◆ _notifyParentNodeMemoryChanged()

virtual void Ogre::MovableObject::_notifyParentNodeMemoryChanged ( void )

inlinevirtualinherited

@See Node::_callMemoryChangeListeners

Reimplemented in Ogre::v1::InstancedEntity, and Ogre::Item.

◆ _notifyStaticDirty()

virtual void Ogre::MovableObject::_notifyStaticDirty ( void ) const

inlinevirtualinherited

Called by SceneManager when it is telling we're a static MovableObject being dirty Don't call this directly.

See also: SceneManager::notifyStaticDirty

Reimplemented in Ogre::v1::InstancedEntity.

◆ _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::v1::BillboardSet, and Ogre::v1::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.

◆ _setHlmsHashes()

virtual void Ogre::Renderable::_setHlmsHashes	(	uint32	hash,
		uint32	casterHash
	)

virtualinherited

Manually sets the hlms hashes. Don't call this directly.

Reimplemented in Ogre::SubItem.

◆ _setNullDatablock()

virtual void Ogre::Renderable::_setNullDatablock ( void )

virtualinherited

Sets the datablock to a null pointer.

Use case: If you will be destroying an HlmsDatablock and all Renderables associated by it; it makes no sense to change the Renderable's datablock to a default one, only to be destroyed immediately after (you pay an unnecessary performance price).

Remarks: Do not attempt to render a Renderable whose datablock has been set to null. It will crash. You can call setDatablock afterwards though. Use at your own risk, hence the _underscore. See http://ogre3d.org/forums/viewtopic.php?f=25&t=91791&p=534476#p534476

Reimplemented in Ogre::v1::BillboardSet, and Ogre::v1::SubEntity.

◆ _updateCustomGpuParameter()

virtual void Ogre::Renderable::_updateCustomGpuParameter	(	const GpuProgramParameters::AutoConstantEntry &	constantEntry,
		GpuProgramParameters *	params
	)		const

inlinevirtualinherited

Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.

Remarks: This method allows a Renderable to map in a custom GPU program parameter based on it's own data. This is represented by a GPU auto parameter of ACT_CUSTOM, and to allow there to be more than one of these per Renderable, the 'data' field on the auto parameter will identify which parameter is being updated. The implementation of this method must identify the parameter being updated, and call a 'setConstant' method on the passed in GpuProgramParameters object, using the details provided in the incoming auto constant setting to identify the index at which to set the parameter.

: You do not need to override this method if you're using the standard sets of data associated with the Renderable as provided by setCustomParameter and getCustomParameter. By default, the implementation will map from the value indexed by the 'constantEntry.data' parameter to a value previously set by setCustomParameter. But custom Renderables are free to override this if they want, in any case.

Parameters

constantEntry	The auto constant entry referring to the parameter being updated
params	The parameters object which this method should call to set the updated parameters.

Reimplemented in Ogre::v1::SubEntity.

◆ _updateRenderQueue()

virtual void Ogre::MovableObject::_updateRenderQueue	(	RenderQueue *	queue,
		Camera *	camera,
		const Camera *	lodCamera
	)

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.

Reimplemented in Ogre::v1::BillboardChain, Ogre::MovablePlane, Ogre::v1::BillboardSet, Ogre::v1::Entity, Ogre::v1::InstanceBatchHW, Ogre::v1::InstanceBatchHW_VTF, Ogre::v1::BaseInstanceBatchVTF, Ogre::v1::InstancedEntity, Ogre::Light, Ogre::v1::ManualObject, Ogre::ParticleSystem, and Ogre::v1::StaticGeometry::Region.

◆ addPoseWeight()

void Ogre::Renderable::addPoseWeight	(	size_t	index,
		float	w
	)

inherited

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

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

◆ buildLightList()

static void Ogre::MovableObject::buildLightList	(	const size_t	numNodes,
		ObjectData	t,
		const LightListInfo &	globalLightList
	)

staticinherited

@See SceneManager::buildLightList

Remarks: We don't pass by reference on purpose (avoid implicit aliasing)

Parameters

globalLightList List of lights already culled against all possible frustums and reorganized contiguously for SoA

◆ calculateCastersBox()

static void Ogre::MovableObject::calculateCastersBox	(	const size_t	numNodes,
		ObjectData	t,
		uint32	sceneVisibilityFlags,
		AxisAlignedBox *	outBox
	)

staticinherited

◆ calcViewMatrixRelative()

virtual void Ogre::Frustum::calcViewMatrixRelative	(	const Vector3 &	relPos,
		Matrix4 &	matToUpdate
	)		const

virtual

Calculate a view matrix for this frustum, relative to a potentially dynamic point.

Mainly for use by OGRE internally when using camera-relative rendering for frustums that are not the centre (e.g. texture projection)

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

◆ cullFrustum()

static void Ogre::MovableObject::cullFrustum	(	const size_t	numNodes,
		ObjectData	t,
		const Camera *	frustum,
		uint32	sceneVisibilityFlags,
		MovableObjectArray &	outCulledObjects,
		const Camera *	lodCamera
	)

staticinherited

◆ cullLights()

static void Ogre::MovableObject::cullLights	(	const size_t	numNodes,
		ObjectData	t,
		LightListInfo &	outGlobalLightList,
		const FrustumVec &	frustums,
		const FrustumVec &	cubemapFrustums
	)

staticinherited

@See SceneManager::cullLights &

See also: MovableObject::cullFrustum Produces the global list of visible lights that is needed in buildLightList

Remarks: We don't pass ObjectData by reference on purpose (avoid implicit aliasing) It's declared here because all affected elements are from MovableObject IMPORTANT: It is assumed that all objects in ObjectData are Lights.

Parameters

outGlobalLightList	Output, a list of lights, contiguously placed
frustums	An array of all frustums we need to check against
cubemapFrustums	An array of all frustums that are used at least once as cubemaps (@See SceneManager::createCamera)

◆ detachFromParent()

void Ogre::MovableObject::detachFromParent ( void )

inherited

Detaches an object from a parent SceneNode if attached.

◆ disableCustomNearClipPlane()

virtual void Ogre::Frustum::disableCustomNearClipPlane ( void )

virtual

Disables any custom near clip plane.

◆ disableReflection()

virtual void Ogre::Frustum::disableReflection ( void )

virtual

Disables reflection modification previously turned on with enableReflection.

◆ enableCustomNearClipPlane() [1/2]

virtual void Ogre::Frustum::enableCustomNearClipPlane ( const MovablePlane * plane )

virtual

Links the frustum to a custom near clip plane, which can be used to clip geometry in a custom manner without using user clip planes.

Remarks: There are several applications for clipping a scene arbitrarily by a single plane; the most common is when rendering a reflection to a texture, and you only want to render geometry that is above the water plane (to do otherwise results in artefacts). Whilst it is possible to use user clip planes, they are not supported on all cards, and sometimes are not hardware accelerated when they are available. Instead, where a single clip plane is involved, this technique uses a 'fudging' of the near clip plane, which is available and fast on all hardware, to perform as the arbitrary clip plane. This does change the shape of the frustum, leading to some depth buffer loss of precision, but for many of the uses of this technique that is not an issue.

: This version of the method links to a plane, rather than requiring a by-value plane definition, and therefore you can make changes to the plane (e.g. by moving / rotating the node it is attached to) and they will automatically affect this object.

Note: This technique only works for perspective projection.

Parameters

plane The plane to link to to perform the clipping. This plane must continue to exist while the camera is linked to it; do not destroy it before the frustum.

◆ enableCustomNearClipPlane() [2/2]

virtual void Ogre::Frustum::enableCustomNearClipPlane ( const Plane & plane )

virtual

Links the frustum to a custom near clip plane, which can be used to clip geometry in a custom manner without using user clip planes.

Remarks: There are several applications for clipping a scene arbitrarily by a single plane; the most common is when rendering a reflection to
a texture, and you only want to render geometry that is above the water plane (to do otherwise results in artefacts). Whilst it is possible to use user clip planes, they are not supported on all cards, and sometimes are not hardware accelerated when they are available. Instead, where a single clip plane is involved, this technique uses a 'fudging' of the near clip plane, which is available and fast on all hardware, to perform as the arbitrary clip plane. This does change the shape of the frustum, leading to some depth buffer loss of precision, but for many of the uses of this technique that is not an issue.

Note: This technique only works for perspective projection.

Parameters

plane The plane to link to to perform the clipping. This plane must continue to exist while the camera is linked to it; do not destroy it before the frustum.

◆ enableReflection() [1/2]

virtual void Ogre::Frustum::enableReflection ( const MovablePlane * p )

virtual

Modifies this frustum so it always renders from the reflection of itself through the plane specified.

Note that this version of the method links to a plane so that changes to it are picked up automatically. It is important that this plane continues to exist whilst this object does; do not destroy the plane before the frustum.

Remarks: This is obviously useful for performing planar reflections.

◆ enableReflection() [2/2]

virtual void Ogre::Frustum::enableReflection ( const Plane & p )

virtual

Modifies this frustum so it always renders from the reflection of itself through the plane specified.

Remarks: This is obviously useful for performing planar reflections.

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

◆ getAspectRatio()

virtual Real Ogre::Frustum::getAspectRatio ( void ) const

virtual

Retrieves the current aspect ratio.

◆ getBoundingBox()

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

Overridden from MovableObject.

◆ getCachedDistanceToCamera()

RealAsUint Ogre::MovableObject::getCachedDistanceToCamera ( void ) const

inlineinherited

Returns the distance to camera as calculated in @cullFrustum.

◆ getCachedDistanceToCameraAsReal()

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

inlineinherited

Returns the distance to camera as calculated in @cullFrustum.

◆ getCastShadows()

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

inlineinherited

Returns whether shadow casting is enabled for this object.

◆ getCastsShadows()

virtual bool Ogre::Renderable::getCastsShadows ( void ) const

inlinevirtualinherited

Method which reports whether this renderable would normally cast a shadow.

Remarks: Subclasses should override this if they could have been used to generate a shadow.

Reimplemented in Ogre::v1::StaticGeometry::GeometryBucket, Ogre::v1::SubEntity, Ogre::SubItem, Ogre::WireAabb, and Ogre::ManualObject::ManualObjectSection.

◆ getCurrentMaterialLod()

uint8 Ogre::Renderable::getCurrentMaterialLod ( void ) const

inlineinherited

◆ getCurrentMeshLod()

unsigned char Ogre::MovableObject::getCurrentMeshLod ( void ) const

inlineinherited

◆ getCustomParameter()

const Vector4 & Ogre::Renderable::getCustomParameter ( size_t index ) const

inlineinherited

Gets the custom value associated with this Renderable at the given index.

Parameters

index Index of the parameter to retrieve.

See also: setCustomParameter for full details.

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

◆ getCustomParameters()

const CustomParameterMap & Ogre::Renderable::getCustomParameters ( void ) const

inlineinherited

◆ getCustomWorldSpaceCorners()

void Ogre::Frustum::getCustomWorldSpaceCorners	(	ArrayVector3	outCorners[(8+ARRAY_PACKED_REALS - 1)/ARRAY_PACKED_REALS],
		Real	customFarPlane
	)		const

◆ getDatablock()

HlmsDatablock * Ogre::Renderable::getDatablock ( void ) const

inlineinherited

◆ getDefaultQueryFlags()

static uint32 Ogre::MovableObject::getDefaultQueryFlags ( )

inlinestaticinherited

Get the default query flags for all future MovableObject instances.

◆ getDefaultVisibilityFlags()

static uint32 Ogre::MovableObject::getDefaultVisibilityFlags ( )

inlinestaticinherited

Get the default visibility flags for all future MovableObject instances.

◆ getFarClipDistance()

virtual Real Ogre::Frustum::getFarClipDistance ( void ) const

virtual

Retrieves the distance from the frustum to the far clipping plane.

Reimplemented in Ogre::Camera.

◆ getFocalLength()

virtual Real Ogre::Frustum::getFocalLength ( ) const

virtual

Returns focal length of frustum.

◆ getFOVy()

virtual const Radian & Ogre::Frustum::getFOVy ( void ) const

virtual

Retrieves the frustums Y-dimension Field Of View (FOV).

◆ getFrustumExtents()

virtual void Ogre::Frustum::getFrustumExtents	(	Real &	outleft,
		Real &	outright,
		Real &	outtop,
		Real &	outbottom,
		FrustrumExtentsType	frustrumExtentsType = `FET_PROJ_PLANE_POS`
	)		const

virtual

Get the extents of the frustum in view space.

Parameters

left,right,top,bottom	The position where the side clip planes intersect the near clip plane, in eye space OR the tangent of the half angles from the eye to the edges of the near clip plane
frustrumExtentsType	Specifies in what format the extents are returned. See OgreFrustrum::setFrustumExtents for more information

◆ getFrustumOffset()

virtual const Vector2 & Ogre::Frustum::getFrustumOffset ( ) const

virtual

Retrieves the frustum offsets.

◆ getFrustumPlane()

const Plane & Ogre::Frustum::getFrustumPlane ( unsigned short plane ) const

Retrieves a specified plane of the frustum (world space).

Remarks: Gets a reference to one of the planes which make up the frustum frustum, e.g. for clipping purposes.

◆ getFrustumPlanes()

const Plane * Ogre::Frustum::getFrustumPlanes ( void ) const

Retrieves the clipping planes of the frustum (world space).

Remarks: The clipping planes are ordered as declared in enumerate constants FrustumPlane.

◆ getHlmsCasterHash()

uint32 Ogre::Renderable::getHlmsCasterHash ( void ) const

inlineinherited

◆ getHlmsHash()

uint32 Ogre::Renderable::getHlmsHash ( void ) const

inlineinherited

◆ getId()

IdType Ogre::IdObject::getId ( ) const

inlineinherited

Get the unique id of 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

◆ getLights()

const LightList & Ogre::Frustum::getLights ( void ) const

virtual

Overridden from Renderable.

Implements Ogre::Renderable.

◆ getListener()

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

inlineinherited

Gets the current listener for this object.

◆ getLocalAabb()

Aabb Ogre::MovableObject::getLocalAabb ( void ) const

inherited

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

Remarks: This bounding box is in local coordinates.

◆ getLocalRadius()

float Ogre::MovableObject::getLocalRadius ( void ) const

inherited

See getLocalAabb and getWorldRadius.

◆ getMaterial()

MaterialPtr Ogre::Renderable::getMaterial ( void ) const

inherited

Retrieves the material this renderable object uses.

It may be null if it's using the HLMS. @See getDatablock

◆ getMovableType()

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

virtual

Overridden from MovableObject.

Implements Ogre::MovableObject.

◆ getName()

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

inlineinherited

Returns the name of this object.

◆ getNearClipDistance()

virtual Real Ogre::Frustum::getNearClipDistance ( void ) const

virtual

Sets the position of the near clipping plane.

Reimplemented in Ogre::Camera.

◆ getNumPoses()

unsigned short Ogre::Renderable::getNumPoses ( void ) const

inherited

◆ getNumWorldTransforms()

virtual unsigned short Ogre::Renderable::getNumWorldTransforms ( void ) const

inlinevirtualinherited

Returns the number of world transform matrices this renderable requires.

Remarks: When a renderable uses vertex blending, it uses multiple world matrices instead of a single one. Each vertex sent to the pipeline can reference one or more matrices in this list with given weights. If a renderable does not use vertex blending this method returns 1, which is the default for simplicity.

Reimplemented in Ogre::v1::BorderRenderable, Ogre::v1::InstanceBatchHW, Ogre::v1::InstanceBatchShader, Ogre::v1::BaseInstanceBatchVTF, and Ogre::v1::SubEntity.

◆ getOrientationForViewUpdate()

virtual const Quaternion & Ogre::Frustum::getOrientationForViewUpdate ( void ) const

virtual

Get the derived orientation of this frustum.

Reimplemented in Ogre::Camera.

◆ getOrientationMode()

OrientationMode Ogre::Frustum::getOrientationMode ( ) const

Get the orientation mode of the frustum.

Remarks: Getting the orientation of a frustum is only supported on iOS at this time. An exception is thrown on other platforms.

◆ getOrthoWindowHeight()

virtual Real Ogre::Frustum::getOrthoWindowHeight ( ) const

virtual

Gets the orthographic window height, for use with orthographic rendering only.

◆ getOrthoWindowWidth()

virtual Real Ogre::Frustum::getOrthoWindowWidth ( ) const

virtual

Gets the orthographic window width, for use with orthographic rendering only.

Note: This is calculated from the orthographic height and the aspect ratio

◆ getParentNode()

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

inlineinherited

Returns the node to which this object is attached.

◆ getParentSceneNode()

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

inlineinherited

◆ getPlaneBoundedVolume()

PlaneBoundedVolume Ogre::Frustum::getPlaneBoundedVolume ( )

Gets a world-space list of planes enclosing the frustum.

◆ getPolygonModeOverrideable()

virtual bool Ogre::Renderable::getPolygonModeOverrideable ( void ) const

inlinevirtualinherited

Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

Reimplemented in Ogre::v1::BorderRenderable.

Referenced by Ogre::v1::BorderRenderable::getPolygonModeOverrideable().

◆ getPoseHalfPrecision()

bool Ogre::Renderable::getPoseHalfPrecision ( ) const

inherited

◆ getPoseNormals()

bool Ogre::Renderable::getPoseNormals ( ) const

inherited

◆ getPoseTexBuffer()

TexBufferPacked * Ogre::Renderable::getPoseTexBuffer ( ) const

inherited

◆ getPoseWeight()

float Ogre::Renderable::getPoseWeight ( size_t index ) const

inherited

◆ getPoseWeights()

float * Ogre::Renderable::getPoseWeights ( ) const

inherited

◆ getPositionForViewUpdate()

virtual const Vector3 & Ogre::Frustum::getPositionForViewUpdate ( void ) const

virtual

Get the derived position of this frustum.

Reimplemented in Ogre::Camera.

◆ getProjectionMatrix()

virtual const Matrix4 & Ogre::Frustum::getProjectionMatrix ( void ) const

virtual

Gets the normal projection matrix for this frustum, ie the projection matrix which conforms to standard right-handed rules and uses depth range [-1,+1].

Remarks: This differs from the rendering-API dependent getProjectionMatrixRS in that it always returns a right-handed projection matrix with depth range [-1,+1], result no matter what rendering API is being used - this is required for some uniform algebra for example.

◆ getProjectionMatrixRS()

virtual const Matrix4 & Ogre::Frustum::getProjectionMatrixRS ( void ) const

virtual

Gets the projection matrix for this frustum adjusted for the current rendersystem specifics (may be right or left-handed, depth range may vary).

Remarks: This method retrieves the rendering-API dependent version of the projection matrix. If you want a 'typical' projection matrix then use getProjectionMatrix.

◆ getProjectionMatrixWithRSDepth()

virtual const Matrix4 & Ogre::Frustum::getProjectionMatrixWithRSDepth ( void ) const

virtual

Gets the depth-adjusted projection matrix for the current rendersystem, but one which still conforms to right-hand rules.

Remarks: This differs from the rendering-API dependent getProjectionMatrix in that it always returns a right-handed projection matrix result no matter what rendering API is being used - this is required for vertex and fragment programs for example. However, the resulting depth range may still vary between render systems since D3D uses [0,1] and GL uses [-1,1], and the range must be kept the same between programmable and fixed-function pipelines.

◆ getProjectionType()

virtual ProjectionType Ogre::Frustum::getProjectionType ( void ) const

virtual

Retrieves info on the type of projection used (orthographic or perspective).

◆ getQueryFlags()

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

inlineinherited

Returns the query flags relevant for this object.

◆ getReflectionMatrix()

virtual const Matrix4 & Ogre::Frustum::getReflectionMatrix ( void ) const

inlinevirtual

Returns the reflection matrix of the frustum if appropriate.

◆ getReflectionPlane()

virtual const Plane & Ogre::Frustum::getReflectionPlane ( void ) const

inlinevirtual

Returns the reflection plane of the frustum if appropriate.

◆ getRenderingDistance()

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

inlineinherited

Gets the distance at which batches are no longer 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.

◆ getRenderOperation()

void Ogre::Frustum::getRenderOperation	(	v1::RenderOperation &	op,
		bool	casterPass
	)

virtual

Overridden from Renderable.

Implements Ogre::Renderable.

◆ getRenderQueueGroup()

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

inlineinherited

Gets the queue group for this entity, see setRenderQueueGroup for full details.

◆ getRenderQueueSubGroup()

uint8 Ogre::Renderable::getRenderQueueSubGroup ( void ) const

inlineinherited

◆ getShadowRenderingDistance()

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

inlineinherited

Gets the distance at which batches are no longer casting shadows.

◆ getSkeletonInstance()

SkeletonInstance * Ogre::MovableObject::getSkeletonInstance ( void ) const

inlineinherited

◆ getSquaredViewDepth()

Real Ogre::Frustum::getSquaredViewDepth ( const Camera * cam ) const

Overridden from Renderable.

◆ getUseIdentityProjection()

bool Ogre::Renderable::getUseIdentityProjection ( void ) const

inlineinherited

Returns whether or not to use an 'identity' projection.

Remarks: Usually Renderable objects will use a projection matrix as determined by the active camera. However, if they want they can cancel this out and use an identity projection, which effectively projects in 2D using a {-1, 1} view space. Useful for overlay rendering. Normal renderables need not change this.

See also: Renderable::setUseIdentityProjection

◆ getUseIdentityView()

bool Ogre::Renderable::getUseIdentityView ( void ) const

inlineinherited

Returns whether or not to use an 'identity' view.

Remarks: Usually Renderable objects will use a view matrix as determined by the active camera. However, if they want they can cancel this out and use an identity matrix, which means all geometry is assumed to be relative to camera space already. Useful for overlay rendering. Normal renderables need not change this.

See also: Renderable::setUseIdentityView

◆ getUseIdentityViewProjMatrixIsDynamic()

virtual bool Ogre::Renderable::getUseIdentityViewProjMatrixIsDynamic ( void ) const

inlinevirtualinherited

Returns whether the Hlms implementation should evaluate getUseIdentityProjection per object at runtime, or if it can assume the Renderable will remain with the same setting until the datablock is flushed (performance optimization)

Remarks: Hlms implementations may ignore this setting (e.g. assume always true or always false) or even not support identity matrix overrides at all. For example currently Unlit supports them all, but will assume this returns always true if getUseIdentityWorldMatrix returns false.

◆ getUseIdentityWorldMatrix()

virtual bool Ogre::Renderable::getUseIdentityWorldMatrix ( void ) const

inlinevirtualinherited

Returns whether the world matrix is an identity matrix.

Remarks: It is up to the Hlms implementation whether to honour this request. Take in mind changes of this value at runtime may not be seen until the datablock is flushed. It is implemented as a virtual call because this functionality isn't required very often (hence we save per-Renderable space for those that don't use it) and this function will be called at creation time to use a different shader; not during rendering time per Renderable.

Reimplemented in Ogre::v1::BillboardSet.

◆ getUserAny()

virtual OGRE_DEPRECATED const Any & Ogre::Renderable::getUserAny ( void ) const

inlinevirtualinherited

Deprecated:: use UserObjectBindings::getUserAny via getUserObjectBindings() instead. Retrieves the custom user value associated with this object.

Reimplemented in Ogre::v1::InstanceBatch.

◆ getUserObjectBindings() [1/4]

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/4]

UserObjectBindings & Ogre::Renderable::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() [3/4]

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.

◆ getUserObjectBindings() [4/4]

const UserObjectBindings & Ogre::Renderable::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.

◆ getVaos()

const VertexArrayObjectArray & Ogre::Renderable::getVaos ( VertexPass vertexPass ) const

inlineinherited

◆ getViewMatrix()

virtual const Matrix4 & Ogre::Frustum::getViewMatrix ( void ) const

virtual

Gets the view matrix for this frustum.

Mainly for use by OGRE internally.

Reimplemented in Ogre::Camera.

◆ getVisibilityFlags()

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

inlineinherited

Returns the visibility flags relevant for this object.

Reserved visibility flags are not returned.

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

◆ getWorldAabb()

Aabb Ogre::MovableObject::getWorldAabb ( ) const

inherited

Gets the axis aligned box in world space.

Remarks: Assumes the caches are already updated. Will trigger an assert otherwise. @See getWorldAabbUpdated if you need the update process to be guaranteed

◆ getWorldAabbUpdated()

Aabb Ogre::MovableObject::getWorldAabbUpdated ( )

inherited

Gets the axis aligned box in world space.

Remarks: Unlike getWorldAabb, this function guarantees the cache stays up to date. It is STRONGLY advised against calling this function for a large number of MovableObject. Refactor your queries so that they happen after SceneManager::updateAllBounds() has been called

◆ getWorldRadius()

float Ogre::MovableObject::getWorldRadius ( ) const

inherited

Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).

Remarks: Assumes the caches are already updated. Will trigger an assert otherwise. @See getWorldRadiusUpdated if you need the update process to be guaranteed

◆ getWorldRadiusUpdated()

float Ogre::MovableObject::getWorldRadiusUpdated ( )

inherited

Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).

Remarks: Unlike getWorldRadius, this function guarantees the cache stays up to date. It is STRONGLY advised against calling this function for a large number of MovableObject. Refactor your queries so that they happen after SceneManager::updateAllBounds() has been called

◆ getWorldSpaceCorners()

virtual const Vector3 * Ogre::Frustum::getWorldSpaceCorners ( void ) const

virtual

Gets the world space corners of the frustum.

Remarks: The corners are ordered as follows: top-right near, top-left near, bottom-left near, bottom-right near, top-right far, top-left far, bottom-left far, bottom-right far.

Reimplemented in Ogre::Camera.

◆ getWorldTransforms()

void Ogre::Frustum::getWorldTransforms ( Matrix4 * xform ) const

virtual

Overridden from Renderable.

Implements Ogre::Renderable.

◆ hasCustomParameter()

bool Ogre::Renderable::hasCustomParameter ( size_t index ) const

inlineinherited

Checks whether a custom value is associated with this Renderable at the given index.

Parameters

index Index of the parameter to check for existence.

See also: setCustomParameter for full details.

◆ hasSkeletonAnimation()

bool Ogre::Renderable::hasSkeletonAnimation ( void ) const

inlineinherited

◆ instanceBatchCullFrustumThreaded()

virtual void Ogre::MovableObject::instanceBatchCullFrustumThreaded	(	const Frustum *	frustum,
		const Camera *	lodCamera,
		uint32	combinedVisibilityFlags
	)

inlinevirtualinherited

@See InstancingTheadedCullingMethod,

See also: InstanceBatch::instanceBatchCullFrustumThreaded

◆ isAttached()

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

inlineinherited

Returns true if this object is attached to a Node.

◆ isCustomNearClipPlaneEnabled()

virtual bool Ogre::Frustum::isCustomNearClipPlaneEnabled ( void ) const

inlinevirtual

Is a custom near clip plane in use?

◆ isCustomProjectionMatrixEnabled()

virtual bool Ogre::Frustum::isCustomProjectionMatrixEnabled ( void ) const

inlinevirtual

Returns whether a custom projection matrix is in use.

◆ isCustomViewMatrixEnabled()

virtual bool Ogre::Frustum::isCustomViewMatrixEnabled ( void ) const

inlinevirtual

Returns whether a custom view matrix is in use.

◆ isReflected()

virtual bool Ogre::Frustum::isReflected ( void ) const

inlinevirtual

Returns whether this frustum is being reflected.

◆ isStatic()

bool Ogre::MovableObject::isStatic ( ) const

inherited

Checks whether this MovableObject is static. @See setStatic.

◆ isVisible() [1/4]

virtual bool Ogre::Frustum::isVisible	(	const AxisAlignedBox &	bound,
		FrustumPlane *	culledBy = `0`
	)		const

virtual

Tests whether the given container is visible in the Frustum.

Parameters

bound	Bounding box to be checked (world space).
culledBy	Optional pointer to an int which will be filled by the plane number which culled the box if the result was `false`;

Returns: If the box was visible, true is returned.

: Otherwise, false is returned.

Reimplemented in Ogre::Camera, and Ogre::PCZCamera.

◆ isVisible() [2/4]

virtual bool Ogre::Frustum::isVisible	(	const Sphere &	bound,
		FrustumPlane *	culledBy = `0`
	)		const

virtual

Tests whether the given container is visible in the Frustum.

Parameters

bound	Bounding sphere to be checked (world space).
culledBy	Optional pointer to an int which will be filled by the plane number which culled the box if the result was `false`;

Returns: If the sphere was visible, true is returned.

: Otherwise, false is returned.

Reimplemented in Ogre::Camera.

◆ isVisible() [3/4]

virtual bool Ogre::Frustum::isVisible	(	const Vector3 &	vert,
		FrustumPlane *	culledBy = `0`
	)		const

virtual

Tests whether the given vertex is visible in the Frustum.

Parameters

vert	Vertex to be checked (world space).
culledBy	Optional pointer to an int which will be filled by the plane number which culled the box if the result was `false`;

Returns: If the sphere was visible, true is returned.

: Otherwise, false is returned.

Reimplemented in Ogre::Camera.

◆ isVisible() [4/4]

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

inherited

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

Remarks: Takes into account visibility flags and the setVisible, but not rendering distance.

◆ operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr )

inlineinherited

◆ operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

◆ operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)

inlineinherited

◆ operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr )

inlineinherited

◆ operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

◆ operator new() [1/3]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new ( size_t sz )

inlineinherited

◆ operator new() [2/3]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

operator new, with debug line info

◆ operator new() [3/3]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)

inlineinherited

placement operator new

◆ operator new[]() [1/2]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz )

inlineinherited

◆ operator new[]() [2/2]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

array operator new, with debug line info

◆ operator()() [1/2]

bool Ogre::IdObject::operator()	(	const IdObject &	left,
		const IdObject &	right
	)

inlineinherited

◆ operator()() [2/2]

bool Ogre::IdObject::operator()	(	const IdObject *	left,
		const IdObject *	right
	)

inlineinherited

◆ postRender()

virtual void Ogre::Renderable::postRender	(	SceneManager *	sm,
		RenderSystem *	rsys
	)

inlinevirtualinherited

Called immediately after the Renderable has been rendered.

◆ preRender()

virtual bool Ogre::Renderable::preRender	(	SceneManager *	sm,
		RenderSystem *	rsys
	)

inlinevirtualinherited

Called just prior to the Renderable being rendered.

Remarks: OGRE is a queued renderer, so the actual render commands are executed at a later time than the point at which an object is discovered to be visible. This allows ordering & grouping of renders without the discovery process having to be aware of it. It also means OGRE uses declarative render information rather than immediate mode rendering - this is very useful in that certain effects and processes can automatically be applied to a wide range of scenes, but the downside is that special cases are more difficult to handle, because there is not the declared state to cope with it.

: This method allows a Renderable to do something special at the actual point of rendering if it wishes to. When this method is called, all the material render state as declared by this Renderable has already been set, all that is left to do is to bind the buffers and perform the render. The Renderable may modify render state itself if it wants to (and restore it in the postRender call) before the automated render happens, or by returning 'false' from this method can actually suppress the automatic render and perform one of its own.

Returns: true if the automatic render should proceed, false to skip it on the assumption that the Renderable has done it manually.

Reimplemented in Ogre::v1::BillboardChain.

◆ projectSphere()

virtual bool Ogre::Frustum::projectSphere	(	const Sphere &	sphere,
		Real *	left,
		Real *	top,
		Real *	right,
		Real *	bottom
	)		const

virtual

Project a sphere onto the near plane and get the bounding rectangle.

Parameters

sphere	The world-space sphere to project.
left	Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}).
top	Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}).
right	Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}).
bottom	Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}).

Returns: true if the sphere was projected to a subset of the near plane, false if the entire near plane was contained.

Reimplemented in Ogre::Camera.

◆ queryLights()

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

inlineinherited

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

Remarks: The lights are filled in

See also: buildLightList

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

◆ removeCustomParameter()

void Ogre::Renderable::removeCustomParameter ( size_t index )

inlineinherited

Removes a custom value which is associated with this Renderable at the given index.

Parameters

index Index of the parameter to remove.

See also: setCustomParameter for full details.

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

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

◆ resetFrustumExtents()

virtual void Ogre::Frustum::resetFrustumExtents ( )

virtual

Reset the frustum extents to be automatically derived from other params.

◆ setAspectRatio()

virtual void Ogre::Frustum::setAspectRatio ( Real ratio )

virtual

Sets the aspect ratio for the frustum viewport.

Remarks: The ratio between the x and y dimensions of the rectangular area visible through the frustum is known as aspect ratio: aspect = width / height .

: The default for most fullscreen windows is 1.3333 - this is also assumed by Ogre unless you use this method to state otherwise.

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

◆ setCustomParameter()

void Ogre::Renderable::setCustomParameter	(	size_t	index,
		const Vector4 &	value
	)

inlineinherited

Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.

Remarks: Calling this method simply associates a numeric index with a 4-dimensional value for this specific Renderable. This is most useful if the material which this Renderable uses a vertex or fragment program, and has an ACT_CUSTOM parameter entry. This parameter entry can refer to the index you specify as part of this call, thereby mapping a custom parameter for this renderable to a program parameter.

Parameters

index	The index with which to associate the value. Note that this does not have to start at 0, and can include gaps. It also has no direct correlation with a GPU program parameter index - the mapping between the two is performed by the ACT_CUSTOM entry, if that is used.
value	The value to associate.

◆ setCustomProjectionMatrix()

virtual void Ogre::Frustum::setCustomProjectionMatrix	(	bool	enable,
		const Matrix4 &	projectionMatrix = `Matrix4::IDENTITY`,
		bool	alternateDepthRange = `false`
	)

virtual

Set whether to use a custom projection matrix on this frustum.

Remarks: This is an advanced method which allows you to manually set the projection matrix on this frustum, rather than having it calculate itself based on the clipping distances or the field of view.

See Frustum::setCustomViewMatrix

Note: After enabling a custom projection matrix, the frustum will no longer update on its own based on field of view and near / far distance changes. You are completely responsible for keeping the projection matrix up to date if those values change. The custom matrix will be returned from getProjectionMatrix and derivative functions. Even when using a custom projection matrix, you should still call the methods that update the ner / far distances and field of view.

Parameters

enable	If `true`, the custom projection matrix passed as the second parameter will be used in preference to an auto calculated one. If `false`, the frustum will revert to auto calculating the projection matrix.
projectionMatrix	The custom view matrix to use.
alternateDepthRange	Set this to true if the input projectionMatrix has the depth in range [0; 1] instead of the range [-1; 1] that Ogre expects.

Projection matrices obtained from Oculus SDK's need to set this to true.

Note that we will internally convert the projection matrix by performing the range conversion, so don't expect Frustum::getProjectionMatrix to return you exactly the same projection matrix you passed to us!

◆ setCustomViewMatrix()

virtual void Ogre::Frustum::setCustomViewMatrix	(	bool	enable,
		const Matrix4 &	viewMatrix = `Matrix4::IDENTITY`
	)

virtual

Set whether to use a custom view matrix on this frustum.

Remarks: This is an advanced method which allows you to manually set the view matrix on this frustum, rather than having it calculate itself based on it's position and orientation.

Note: After enabling a custom view matrix, the frustum will no longer update on its own based on position / orientation changes. You are completely responsible for keeping the view matrix up to date. The custom matrix will be returned from getViewMatrix.

Parameters

enable	If `true`, the custom view matrix passed as the second parameter will be used in preference to an auto calculated one. If false, the frustum will revert to auto calculating the view matrix.
viewMatrix	The custom view matrix to use, the matrix must be an affine matrix.

See also: Frustum::setCustomProjectionMatrix, Matrix4::isAffine

◆ setDatablock() [1/2]

virtual void Ogre::Renderable::setDatablock ( HlmsDatablock * datablock )

virtualinherited

Assigns a datablock (i.e. HLMS Material) to this renderable.

Reimplemented in Ogre::v1::BillboardSet, Ogre::v1::SubEntity, and Ogre::v1::SubEntity.

◆ setDatablock() [2/2]

void Ogre::Renderable::setDatablock ( IdString datablockName )

inherited

Assigns a datablock (i.e.

HLMS material) based on its unique name.

Remarks: An null IdString() is valid, it will use the default material

◆ setDatablockOrMaterialName()

void Ogre::Renderable::setDatablockOrMaterialName	(	String	materialName,
		String	groupName
	)

inherited

First tries to see if an HLMS datablock exist with the given name, if not, tries to search among low level materials.

◆ setDefaultQueryFlags()

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

inlinestaticinherited

Set the default query flags for all future MovableObject instances.

◆ setDefaultVisibilityFlags()

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

inlinestaticinherited

Set the default visibility flags for all future MovableObject instances.

◆ setFarClipDistance()

virtual void Ogre::Frustum::setFarClipDistance ( Real farDist )

virtual

Sets the distance to the far clipping plane.

Remarks: The view frustum is a pyramid created from the frustum position and the edges of the viewport. This method sets the distance for the far end of that pyramid. Different applications need different values: e.g. a flight sim needs a much further far clipping plane than a first-person shooter. An important point here is that the larger the ratio between near and far clipping planes, the lower the accuracy of the Z-buffer used to depth-cue pixels. This is because the Z-range is limited to the size of the Z buffer (16 or 32-bit) and the max values must be spread over the gap between near and far clip planes. As it happens, you can affect the accuracy far more by altering the near distance rather than the far distance, but keep this in mind.

Parameters

farDist The distance to the far clipping plane from the frustum in world coordinates.If you specify 0, this means an infinite view distance which is useful especially when projecting shadows; but be careful not to use a near distance too close.

◆ setFocalLength()

virtual void Ogre::Frustum::setFocalLength ( Real focalLength = 1.0 )

virtual

Sets frustum focal length (used in stereo rendering).

Parameters

focalLength The distance to the focal plane from the frustum in world coordinates.

◆ setFOVy()

virtual void Ogre::Frustum::setFOVy ( const Radian & fovy )

virtual

Sets the Y-dimension Field Of View (FOV) of the frustum.

Remarks: Field Of View (FOV) is the angle made between the frustum's position, and the edges of the 'screen' onto which the scene is projected. High values (90+ degrees) result in a wide-angle, fish-eye kind of view, low values (30- degrees) in a stretched, telescopic kind of view. Typical values are between 45 and 60 degrees.

: This value represents the VERTICAL field-of-view. The horizontal field of view is calculated from this depending on the dimensions of the viewport (they will only be the same if the viewport is square).

Note: Setting the FOV overrides the value supplied for frustum::setNearClipPlane.

◆ setFrustumExtents()

virtual void Ogre::Frustum::setFrustumExtents	(	Real	left,
		Real	right,
		Real	top,
		Real	bottom,
		FrustrumExtentsType	frustrumExtentsType = `FET_PROJ_PLANE_POS`
	)

virtual

Manually set the extents of the frustum.

Parameters

left,right,top,bottom	The position where the side clip planes intersect the near clip plane, in eye space OR the tangent of the half angles from the eye to the edges of the near clip plane
frustrumExtentsType	Specifies how the extents are represented. Be default they are the positions on near clip plane. However if this is a scene camera it is recommended that you actually use the tangent of the half angles. ie Half the FoV angles. This is because Ogre uses this camera setup to calculate custom clipping planes for PSSM algorithms, and Forward+ algorithms, but alter the near and far clip distances.

: If you supply extents as positions on the projection plane the near clip distance has already been calculated as part of the supplied extents, however if they are tangent of the half angles Ogre can apply different near clip distances dynamically.

◆ setFrustumOffset() [1/2]

virtual void Ogre::Frustum::setFrustumOffset ( const Vector2 & offset )

virtual

Sets frustum offsets, used in stereo rendering.

Remarks: You can set both horizontal and vertical plane offsets of "eye"; in stereo rendering frustum is moved in horizontal plane. To be able to render from two "eyes" you'll need two cameras rendering on two RenderTargets.

: The frustum offsets is in world coordinates, and default to (0, 0) - no offsets.

Parameters

offset The horizontal and vertical plane offsets.

◆ setFrustumOffset() [2/2]

virtual void Ogre::Frustum::setFrustumOffset	(	Real	horizontal = `0.0`,
		Real	vertical = `0.0`
	)

virtual

Sets frustum offsets, used in stereo rendering.

Remarks: You can set both horizontal and vertical plane offsets of "eye"; in stereo rendering frustum is moved in horizontal plane. To be able to render from two "eyes" you'll need two cameras rendering on two RenderTargets.

: The frustum offsets is in world coordinates, and default to (0, 0) - no offsets.

Parameters

horizontal	The horizontal plane offset.
vertical	The vertical plane offset.

◆ setLightMask()

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

inlineinherited

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

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

◆ setLocalAabb()

void Ogre::MovableObject::setLocalAabb ( const Aabb box )

inherited

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

Remarks: This bounding box is in local coordinates.

◆ setMaterial()

virtual void Ogre::Renderable::setMaterial ( const MaterialPtr & material )

virtualinherited

Sets the given material. Overrides HLMS materials.

Reimplemented in Ogre::v1::SimpleRenderable, Ogre::v1::BillboardSet, and Ogre::v1::SubEntity.

◆ setMaterialName()

void Ogre::Renderable::setMaterialName	(	const String &	name,
		const String &	groupName
	)

inherited

Sets the name of the Material to be used. Prefer using HLMS @See setHlms.

◆ setName()

void Ogre::MovableObject::setName ( const String & name )

inlineinherited

Sets a custom name for this node.

Doesn't have to be unique

◆ setNearClipDistance()

virtual void Ogre::Frustum::setNearClipDistance ( Real nearDist )

virtual

Sets the position of the near clipping plane.

Remarks: The position of the near clipping plane is the distance from the frustums position to the screen on which the world is projected. The near plane distance, combined with the field-of-view and the aspect ratio, determines the size of the viewport through which the world is viewed (in world co-ordinates). Note that this world viewport is different to a screen viewport, which has it's dimensions expressed in pixels. The frustums viewport should have the same aspect ratio as the screen viewport it renders into to avoid distortion.

Parameters

nearDist The distance to the near clipping plane from the frustum in world coordinates.

◆ setOrientationMode()

void Ogre::Frustum::setOrientationMode ( OrientationMode orientationMode )

Set the orientation mode of the frustum.

Default is OR_DEGREE_0

Remarks: Setting the orientation of a frustum is only supported on iOS at this time. An exception is thrown on other platforms.

◆ setOrthoWindow()

virtual void Ogre::Frustum::setOrthoWindow	(	Real	w,
		Real	h
	)

virtual

Sets the orthographic window settings, for use with orthographic rendering only.

Note: Calling this method will recalculate the aspect ratio, use setOrthoWindowHeight or setOrthoWindowWidth alone if you wish to preserve the aspect ratio but just fit one or other dimension to a particular size.

Parameters

w	The width of the view window in world units.
h	The height of the view window in world units.

◆ setOrthoWindowHeight()

virtual void Ogre::Frustum::setOrthoWindowHeight ( Real h )

virtual

Sets the orthographic window height, for use with orthographic rendering only.

Note: The width of the window will be calculated from the aspect ratio.

Parameters

h	The height of the view window in world units.

◆ setOrthoWindowWidth()

virtual void Ogre::Frustum::setOrthoWindowWidth ( Real w )

virtual

Sets the orthographic window width, for use with orthographic rendering only.

Note: The height of the window will be calculated from the aspect ratio.

Parameters

w	The width of the view window in world units.

◆ setPolygonModeOverrideable()

virtual void Ogre::Renderable::setPolygonModeOverrideable ( bool override )

inlinevirtualinherited

Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

Parameters

override true means that a lower camera detail will override this renderables detail level, false means it won't.

◆ setPoseWeight()

void Ogre::Renderable::setPoseWeight	(	size_t	index,
		float	w
	)

inherited

◆ setProjectionType()

virtual void Ogre::Frustum::setProjectionType ( ProjectionType pt )

virtual

Sets the type of projection to use (orthographic or perspective).

Default is perspective.

Reimplemented in Ogre::PCZCamera.

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

◆ setRenderingDistance()

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

inlineinherited

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

Parameters

dist	Distance beyond which the object will not be rendered (the default is FLT_MAX, which means objects are always rendered). Values equal or below zero will be ignored, and cause an assertion in debug mode.

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

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

: Valid render queue ids are between 0 & 254 inclusive

Reimplemented in Ogre::Decal, Ogre::v1::Entity, Ogre::Light, and Ogre::ParticleSystem.

◆ setRenderQueueSubGroup()

void Ogre::Renderable::setRenderQueueSubGroup ( uint8 subGroup )

inlineinherited

Sets the render queue sub group.

Remarks: Within the same RenderQueue ID, you may want to have the renderables to have a specific order (i.e. have a mesh, but the hair submesh with alpha blending needs to be rendered last).

: RenderQueue Subgroups are useful for manually sorting objects, just like RenderQueue IDs. However, RenderQueue IDs can also be useful for skipping large number of objects through clever compositing and thus a performance optimization. Subgroups cannot be used for such optimizations.

Parameters

subGroup The sub group. This value can't exceed OGRE_MAKE_MASK( SubRqIdBits ) @See RenderQueue

◆ setShadowRenderingDistance()

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

inlineinherited

Sets the distance at which the object is no longer casting shadows.

Parameters

dist	Distance beyond which the object will not cast shadows (the default is FLT_MAX, which means objects are always casting shadows). Values equal or below zero will be ignored, and cause an assertion in debug mode.

Note: ShadowRenderingDistance will be clamped to RenderingDistance value

See also: setRenderingDistance

◆ setStatic()

bool Ogre::MovableObject::setStatic ( bool bStatic )

inherited

Turns this Node into static or dynamic.

Remarks: Switching between dynamic and static has some overhead and forces to update all static scene when converted to static. So don't do it frequently. Static objects are not updated every frame, only when requested explicitly. Use this feature if you plan to have this object unaltered for a very long times

: Note all MovableObjects support switching between static & dynamic after they have been created (eg. InstancedEntity)

: Changing this attribute will cause to switch the attribute to our parent node, and as a result, all of its other attached entities. @See Node::setStatic

Returns: True if setStatic made an actual change. False otherwise. Can fail because the object was already static/dynamic, or because switching is not supported

◆ setUseIdentityProjection()

void Ogre::Renderable::setUseIdentityProjection ( bool useIdentityProjection )

inlineinherited

Sets whether or not to use an 'identity' projection.

Remarks: Usually Renderable objects will use a projection matrix as determined by the active camera. However, if they want they can cancel this out and use an identity projection, which effectively projects in 2D using a {-1, 1} view space. Useful for overlay rendering. Normal renderables need not change this. The default is false.

See also: Renderable::getUseIdentityProjection

◆ setUseIdentityView()

void Ogre::Renderable::setUseIdentityView ( bool useIdentityView )

inlineinherited

Sets whether or not to use an 'identity' view.

Remarks: Usually Renderable objects will use a view matrix as determined by the active camera. However, if they want they can cancel this out and use an identity matrix, which means all geometry is assumed to be relative to camera space already. Useful for overlay rendering. Normal renderables need not change this. The default is false.

See also: Renderable::getUseIdentityView

◆ setUserAny()

virtual OGRE_DEPRECATED void Ogre::Renderable::setUserAny ( const Any & anything )

inlinevirtualinherited

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 Renderable. This can be a pointer back to one of your own classes for instance.

Reimplemented in Ogre::v1::InstanceBatch.

◆ 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 that is applied a binary 'and' with the SceneManager's mask and a compositor node pass. To exclude particular objects from rendering. Changes to reserved visibility flags are ignored (won't take effect).

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

◆ updateAllBounds()

static void Ogre::MovableObject::updateAllBounds	(	const size_t	numNodes,
		ObjectData	t
	)

staticinherited

@See SceneManager::updateAllBounds

Remarks: We don't pass by reference on purpose (avoid implicit aliasing)

Member Data Documentation

◆ c_DefaultLodMesh

const FastArray<Real> Ogre::MovableObject::c_DefaultLodMesh

staticinherited

◆ INFINITE_FAR_PLANE_ADJUST

const Real Ogre::Frustum::INFINITE_FAR_PLANE_ADJUST

static

Small constant used to reduce far plane projection to avoid inaccuracies.

◆ mCustomParameter

uint8 Ogre::Renderable::mCustomParameter

inherited

Only valid when using low level materials.

◆ mGlobalIndex

size_t Ogre::MovableObject::mGlobalIndex

inherited

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

Used for O(1) removals.

Remarks: It is the parent (or our creator) the one that sets this value, not ourselves. Do NOT modify it manually.

◆ mHlmsGlobalIndex

uint32 Ogre::Renderable::mHlmsGlobalIndex

inherited

Index in the vector holding this Rendrable reference in the HLMS datablock.

Used for O(1) removals.

Remarks: Despite being public, Do NOT modify it manually.

◆ mParentIndex

size_t Ogre::MovableObject::mParentIndex

inherited

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

Used for O(1) removals.

Remarks: It is the parent (or our creator) the one that sets this value, not ourselves. Do NOT modify it manually.

◆ mRenderables

RenderableArray Ogre::MovableObject::mRenderables

inherited

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

OgreFrustum.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ CustomParameterMap

◆ MovableObjectArray

Constructor & Destructor Documentation

◆ Frustum()

◆ ~Frustum()

Member Function Documentation

◆ _getCachedFrustumPlanes()

◆ _getCachedWorldSpaceCorners()

◆ _getLightList()

◆ _getManager()

◆ _getObjectData()

◆ _getParentNodeFullTransform()

◆ _notifyAttached()

◆ _notifyManager()

◆ _notifyParentNodeMemoryChanged()

◆ _notifyStaticDirty()

◆ _releaseManualHardwareResources()

◆ _restoreManualHardwareResources()

◆ _setHlmsHashes()

◆ _setNullDatablock()

◆ _updateCustomGpuParameter()

◆ _updateRenderQueue()

◆ addPoseWeight()

◆ addQueryFlags()

◆ addVisibilityFlags()

◆ buildLightList()

◆ calculateCastersBox()

◆ calcViewMatrixRelative()

◆ createAnimableValue()

◆ cullFrustum()

◆ cullLights()

◆ detachFromParent()

◆ disableCustomNearClipPlane()

◆ disableReflection()

◆ enableCustomNearClipPlane() [1/2]

◆ enableCustomNearClipPlane() [2/2]

◆ enableReflection() [1/2]

◆ enableReflection() [2/2]

◆ getAnimableValueNames()

◆ getAspectRatio()

◆ getBoundingBox()

◆ getCachedDistanceToCamera()

◆ getCachedDistanceToCameraAsReal()

◆ getCastShadows()

◆ getCastsShadows()

◆ getCurrentMaterialLod()

◆ getCurrentMeshLod()

◆ getCustomParameter()

◆ getCustomParameters()

◆ getCustomWorldSpaceCorners()

◆ getDatablock()

◆ getDefaultQueryFlags()

◆ getDefaultVisibilityFlags()

◆ getFarClipDistance()

◆ getFocalLength()

◆ getFOVy()

◆ getFrustumExtents()

◆ getFrustumOffset()

◆ getFrustumPlane()

◆ getFrustumPlanes()

◆ getHlmsCasterHash()

◆ getHlmsHash()

◆ getId()

◆ getLightMask()

◆ getLights()

◆ getListener()

◆ getLocalAabb()

◆ getLocalRadius()

◆ getMaterial()

◆ getMovableType()

◆ getName()

◆ getNearClipDistance()

◆ getNumPoses()