Built, renderable section of geometry. More...

#include <OgreManualObject.h>

Inheritance diagram for Ogre::ManualObject::ManualObjectSection:

Public Member Functions
	ManualObjectSection (ManualObject *parent, const MaterialPtr &mat, RenderOperation::OperationType opType)

	ManualObjectSection (ManualObject *parent, const String &materialName, RenderOperation::OperationType opType, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)

virtual	~ManualObjectSection ()

void	convertToSubMesh (SubMesh *sm) const
	convert this section to a SubMesh

bool	get32BitIndices () const
	Get whether we need 32-bit indices.

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

const MaterialPtr &	getMaterial (void) const
	Retrieves a weak reference to the material this renderable object uses.

const String &	getMaterialGroup (void) const
	Retrieve the material group in use.

const String &	getMaterialName (void) const
	Retrieve the material name in use.

void	getRenderOperation (RenderOperation &op)
	Gets the render operation required to send this object to the frame buffer.

RenderOperation *	getRenderOperation (void)
	Retrieve render operation for manipulation.

Real	getSquaredViewDepth (const Ogre::Camera *) const
	Returns the camera-relative squared depth of this renderable.

void	getWorldTransforms (Matrix4 *xform) const
	Gets the world transform matrix / matrices for this renderable object.

void	set32BitIndices (bool n32)
	Set whether we need 32-bit indices.

void	setMaterial (const MaterialPtr &mat)
	Update the material in use.

void	setMaterialName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
	update the material name in use

Public Member Functions inherited from Ogre::Renderable
	Renderable ()

virtual	~Renderable ()
	Virtual destructor needed as class has virtual methods.

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 bool	getCastsShadows (void) const
	Method which reports whether this renderable would normally cast a shadow.

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

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

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

const RenderSystemDataPtr &	getRenderSystemData () const

virtual Technique *	getTechnique (void) const
	Retrieves a pointer to the Material Technique this renderable object uses.

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.

const Any &	getUserAny (void) const

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

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

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

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.

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

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.

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

void	setRenderSystemData (RenderSystemDataPtr val) const

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.

void	setUserAny (const Any &anything)

Additional Inherited Members
Public Types inherited from Ogre::Renderable
enum	{ DEFAULT_PRIORITY = 100 }

typedef SharedPtr< RenderSystemData >	RenderSystemDataPtr

Detailed Description

Built, renderable section of geometry.

Constructor & Destructor Documentation

◆ ManualObjectSection() [1/2]

Ogre::ManualObject::ManualObjectSection::ManualObjectSection	(	ManualObject *	parent,
		const String &	materialName,
		RenderOperation::OperationType	opType,
		const String &	groupName = `ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME`
	)

◆ ManualObjectSection() [2/2]

Ogre::ManualObject::ManualObjectSection::ManualObjectSection	(	ManualObject *	parent,
		const MaterialPtr &	mat,
		RenderOperation::OperationType	opType
	)

Remarks: mat should not be null.

◆ ~ManualObjectSection()

virtual Ogre::ManualObject::ManualObjectSection::~ManualObjectSection ( )

virtual

Member Function Documentation

◆ getRenderOperation() [1/2]

RenderOperation * Ogre::ManualObject::ManualObjectSection::getRenderOperation ( void )

Retrieve render operation for manipulation.

◆ getMaterialName()

const String & Ogre::ManualObject::ManualObjectSection::getMaterialName ( void ) const

inline

Retrieve the material name in use.

◆ getMaterialGroup()

const String & Ogre::ManualObject::ManualObjectSection::getMaterialGroup ( void ) const

inline

Retrieve the material group in use.

◆ setMaterialName()

void Ogre::ManualObject::ManualObjectSection::setMaterialName	(	const String &	name,
		const String &	groupName = `ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME`
	)

update the material name in use

◆ setMaterial()

void Ogre::ManualObject::ManualObjectSection::setMaterial ( const MaterialPtr & mat )

Update the material in use.

Remarks: mat should not be null.

◆ set32BitIndices()

void Ogre::ManualObject::ManualObjectSection::set32BitIndices ( bool n32 )

inline

Set whether we need 32-bit indices.

◆ get32BitIndices()

bool Ogre::ManualObject::ManualObjectSection::get32BitIndices ( ) const

inline

Get whether we need 32-bit indices.

◆ getMaterial()

const MaterialPtr & Ogre::ManualObject::ManualObjectSection::getMaterial ( void ) const

virtual

Retrieves a weak reference to the material this renderable object uses.

Remarks: Note that the Renderable also has the option to override the getTechnique method to specify a particular Technique to use instead of the best one available.

Implements Ogre::Renderable.

◆ getRenderOperation() [2/2]

void Ogre::ManualObject::ManualObjectSection::getRenderOperation ( RenderOperation & op )

virtual

Gets the render operation required to send this object to the frame buffer.

Implements Ogre::Renderable.

◆ getWorldTransforms()

void Ogre::ManualObject::ManualObjectSection::getWorldTransforms ( Matrix4 * xform ) const

virtual

Gets the world transform matrix / matrices for this renderable object.

Remarks: If the object has any derived transforms, these are expected to be up to date as long as all the SceneNode structures have been updated before this is called.

: This method will populate transform with 1 matrix if it does not use vertex blending. If it does use vertex blending it will fill the passed in pointer with an array of matrices, the length being the value returned from getNumWorldTransforms.

Note: Internal Ogre never supports non-affine matrix for world transform matrix/matrices, the behavior is undefined if returns non-affine matrix here.

Implements Ogre::Renderable.

◆ getSquaredViewDepth()

Real Ogre::ManualObject::ManualObjectSection::getSquaredViewDepth ( const Ogre::Camera * ) const

virtual

Returns the camera-relative squared depth of this renderable.

Remarks: Used to sort transparent objects. Squared depth is used rather than actual depth to avoid having to perform a square root on the result.

Implements Ogre::Renderable.

◆ getLights()

const LightList & Ogre::ManualObject::ManualObjectSection::getLights ( void ) const

virtual

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

Remarks: Directional lights, which have no position, will always be first on this list.

Implements Ogre::Renderable.

◆ convertToSubMesh()

void Ogre::ManualObject::ManualObjectSection::convertToSubMesh ( SubMesh * sm ) const

convert this section to a SubMesh

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

OgreManualObject.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ManualObjectSection() [1/2]

◆ ManualObjectSection() [2/2]

◆ ~ManualObjectSection()

Member Function Documentation

◆ getRenderOperation() [1/2]

◆ getMaterialName()

◆ getMaterialGroup()

◆ setMaterialName()

◆ setMaterial()

◆ set32BitIndices()

◆ get32BitIndices()

◆ getMaterial()

◆ getRenderOperation() [2/2]

◆ getWorldTransforms()

◆ getSquaredViewDepth()

◆ getLights()

◆ convertToSubMesh()