OGRE  2.3
Object-Oriented Graphics Rendering Engine
Ogre::Decal Class Reference

Decals can have diffuse, normal map, and emissive on top of regular objects. More...

#include <OgreDecal.h>

+ Inheritance diagram for Ogre::Decal:

Public Types

typedef FastArray< MovableObject * > MovableObjectArray
 @See SceneManager::cullFrustum More...
 
enum  Reason {
  Unknown , FromStorageToSysRam , FromSysRamToStorage , GainedResidency ,
  LostResidency , PoolTextureSlotChanged , ResidentToSysRamSync , MetadataCacheOutOfDate ,
  ExceptionThrown , FsaaSettingAlteredByApi , ReadyForRendering , Deleted
}
 

Public Member Functions

 Decal (IdType id, ObjectMemoryManager *objectMemoryManager, SceneManager *manager)
 
virtual ~Decal ()
 
LightList_getLightList ()
 Returns a pointer to the current list of lights for this object. More...
 
SceneManager_getManager (void) const
 Get the manager of this object, if any (internal use only) More...
 
ObjectData_getObjectData ()
 Returns a direct access to the ObjectData state. More...
 
const Matrix4_getParentNodeFullTransform (void) const
 Returns the full transformation of the parent sceneNode or the attachingPoint node. More...
 
virtual void _notifyAttached (Node *parent)
 Internal method called to notify the object that it has been attached to a node. More...
 
void _notifyManager (SceneManager *man)
 Notify the object of it's manager (internal use only) More...
 
virtual void _notifyParentNodeMemoryChanged (void)
 @See Node::_callMemoryChangeListeners More...
 
virtual void _notifyStaticDirty (void) const
 Called by SceneManager when it is telling we're a static MovableObject being dirty Don't call this directly. More...
 
virtual void _releaseManualHardwareResources ()
 Notifies the movable object that hardware resources were lost. More...
 
virtual void _restoreManualHardwareResources ()
 Notifies the movable object that hardware resources should be restored. More...
 
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. More...
 
void addQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
void addVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
virtual AnimableValuePtr createAnimableValue (const String &valueName)
 Create a reference-counted AnimableValuePtr for the named value. More...
 
void detachFromParent (void)
 Detaches an object from a parent SceneNode if attached. More...
 
const StringVectorgetAnimableValueNames (void) const
 Gets a list of animable value names for this object. More...
 
RealAsUint getCachedDistanceToCamera (void) const
 Returns the distance to camera as calculated in @cullFrustum. More...
 
Real getCachedDistanceToCameraAsReal (void) const
 Returns the distance to camera as calculated in @cullFrustum. More...
 
bool getCastShadows (void) const
 Returns whether shadow casting is enabled for this object. More...
 
unsigned char getCurrentMeshLod (void) const
 
TextureGpugetDiffuseTexture (void) const
 
TextureGpugetEmissiveTexture (void) const
 
IdType getId () const
 Get the unique id of this object. More...
 
bool getIgnoreAlphaDiffuse (void) const
 
uint32 getLightMask () const
 Get a bitwise mask which will filter the lights affecting this object. More...
 
ListenergetListener (void) const
 Gets the current listener for this object. More...
 
Aabb getLocalAabb (void) const
 Retrieves the local axis-aligned bounding box for this object. More...
 
float getLocalRadius (void) const
 See getLocalAabb and getWorldRadius. More...
 
float getMetalness (void) const
 
virtual const StringgetMovableType (void) const
 Returns the type name of this object. More...
 
const StringgetName (void) const
 Returns the name of this object. More...
 
TextureGpugetNormalTexture (void) const
 
NodegetParentNode (void) const
 Returns the node to which this object is attached. More...
 
SceneNodegetParentSceneNode (void) const
 
uint32 getQueryFlags (void) const
 Returns the query flags relevant for this object. More...
 
Real getRenderingDistance (void) const
 Gets the distance at which batches are no longer rendered. More...
 
Real getRenderingMinPixelSize () const
 Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
 
uint8 getRenderQueueGroup (void) const
 Gets the queue group for this entity, see setRenderQueueGroup for full details. More...
 
float getRoughness (void) const
 
Real getShadowRenderingDistance (void) const
 Gets the distance at which batches are no longer casting shadows. More...
 
SkeletonInstancegetSkeletonInstance (void) const
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
uint32 getVisibilityFlags (void) const
 Returns the visibility flags relevant for this object. More...
 
bool getVisible (void) const
 Gets this object whether to be visible or not, if it has a renderable component. More...
 
Aabb getWorldAabb () const
 Gets the axis aligned box in world space. More...
 
Aabb getWorldAabbUpdated ()
 Gets the axis aligned box in world space. More...
 
float getWorldRadius () const
 Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). More...
 
float getWorldRadiusUpdated ()
 Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). More...
 
virtual void instanceBatchCullFrustumThreaded (const Frustum *frustum, const Camera *lodCamera, uint32 combinedVisibilityFlags)
 @See InstancingTheadedCullingMethod, More...
 
bool isAttached (void) const
 Returns true if this object is attached to a Node. More...
 
bool isStatic () const
 Checks whether this MovableObject is static. @See setStatic. More...
 
bool isVisible (void) const
 Returns whether or not this object is supposed to be visible or not. More...
 
virtual void notifyTextureChanged (TextureGpu *texture, TextureGpuListener::Reason reason, void *extraData)
 Called when a TextureGpu changed in a way that affects how it is displayed: More...
 
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 More...
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
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 More...
 
bool operator() (const IdObject &left, const IdObject &right)
 
bool operator() (const IdObject *left, const IdObject *right)
 
const LightListqueryLights (void) const
 Gets a list of lights, ordered relative to how close they are to this movable object. More...
 
void removeQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
void removeVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
void setCastShadows (bool enabled)
 Sets whether or not this object will cast shadows. More...
 
void setDiffuseTexture (TextureGpu *diffuseTex)
 Call this family of functions if the input texture is automatically batched We will listen for residency changes and change the internal slice accordingly. More...
 
void setDiffuseTextureRaw (TextureGpu *diffuseTex, uint32 sliceIdx)
 Call this family of functions if the input texture is managed by hand by you. More...
 
void setEmissiveTexture (TextureGpu *emissiveTex)
 
void setEmissiveTextureRaw (TextureGpu *emissiveTex, uint32 sliceIdx)
 
void setIgnoreAlphaDiffuse (bool bIgnore)
 When diffuse textures are used (globally), the alpha component of the diffuse texture will be used to mask all the other textures (e.g. More...
 
void setLightMask (uint32 lightMask)
 Set a bitwise mask which will filter the lights affecting this object. More...
 
void setListener (Listener *listener)
 Sets a listener for this object. More...
 
void setLocalAabb (const Aabb box)
 Sets the local axis-aligned bounding box for this object. More...
 
void setMetalness (float value)
 Value for Metalness. Must be in range [0; 1]. More...
 
void setName (const String &name)
 Sets a custom name for this node. More...
 
void setNormalTexture (TextureGpu *normalTex)
 
void setNormalTextureRaw (TextureGpu *normalTex, uint32 sliceIdx)
 
void setQueryFlags (uint32 flags)
 Sets the query flags for this object. More...
 
void setRectSize (Vector2 planeDimensions, Real depth)
 Helper function to set width, height and depth of the decal. More...
 
void setRenderingDistance (Real dist)
 Sets the distance at which the object is no longer rendered. More...
 
void setRenderingMinPixelSize (Real pixelSize)
 Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
 
virtual void setRenderQueueGroup (uint8 queueID)
 Decals only allow ForwardPlusBase::MinDecalRq <= queueID < ForwardPlusBase::MaxDecalRq. More...
 
void setRoughness (float roughness)
 Value for Roughness. Valid range depends on the BRDF used. More...
 
void setShadowRenderingDistance (Real dist)
 Sets the distance at which the object is no longer casting shadows. More...
 
bool setStatic (bool bStatic)
 Turns this Node into static or dynamic. More...
 
void setVisibilityFlags (uint32 flags)
 Sets the visibility flags for this object. More...
 
void setVisible (bool visible)
 Tells this object whether to be visible or not, if it has a renderable component. More...
 
virtual bool shouldStayLoaded (TextureGpu *texture)
 Return true if this TextureGpu should likely stay loaded or else graphical changes could occur. More...
 

Static Public Member Functions

static void buildLightList (const size_t numNodes, ObjectData t, const LightListInfo &globalLightList)
 @See SceneManager::buildLightList More...
 
static ArrayReal calculateCameraDistance (uint32 _cameraSortMode, const ArrayVector3 &cameraPos, const ArrayVector3 &cameraDir, ArrayAabb *RESTRICT_ALIAS worldAabb, ArrayReal *RESTRICT_ALIAS worldRadius)
 
static void calculateCastersBox (const size_t numNodes, ObjectData t, uint32 sceneVisibilityFlags, AxisAlignedBox *outBox)
 
static void cullFrustum (const size_t numNodes, ObjectData t, const Camera *frustum, uint32 sceneVisibilityFlags, MovableObjectArray &outCulledObjects, const Camera *lodCamera)
 
static void cullLights (const size_t numNodes, ObjectData t, uint32 sceneLightMask, LightListInfo &outGlobalLightList, const FrustumVec &frustums, const FrustumVec &cubemapFrustums)
 @See SceneManager::cullLights & More...
 
static uint32 getDefaultLightMask ()
 Get the default light mask for all future MovableObject instances. More...
 
static uint32 getDefaultQueryFlags ()
 Get the default query flags for all future MovableObject instances. More...
 
static uint32 getDefaultVisibilityFlags ()
 Get the default visibility flags for all future MovableObject instances. More...
 
static void setDefaultLightMask (uint32 mask)
 Set the default light mask for all future MovableObject instances. More...
 
static void setDefaultQueryFlags (uint32 flags)
 Set the default query flags for all future MovableObject instances. More...
 
static void setDefaultVisibilityFlags (uint32 flags)
 Set the default visibility flags for all future MovableObject instances. More...
 
static void updateAllBounds (const size_t numNodes, ObjectData t)
 @See SceneManager::updateAllBounds More...
 

Public Attributes

uint16 mDiffuseIdx
 
uint16 mEmissiveIdx
 
size_t mGlobalIndex
 Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks). More...
 
uint16 mIgnoreDiffuseAlpha
 
float mMetalness
 
uint16 mNormalMapIdx
 
size_t mParentIndex
 Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks). More...
 
RenderableArray mRenderables
 
float mRoughness
 

Static Public Attributes

static const FastArray< Realc_DefaultLodMesh
 

Detailed Description

Decals can have diffuse, normal map, and emissive on top of regular objects.

You can GLOBALLY disable each of these (diffuse/normal/emissive) by setting a null texture in SceneManager::setDecalsDiffuse and co.

If a nullptr is set on e.g. Normal textures, and a Decal uses normal maps, they won't appear. You need to set a valid pointer to SceneManager::setDecalsNormals.

Likewise, if no Decal actually uses normal textures, but you still set one via SceneManager::setDecalsNormals, then you will be wasting GPU shader performance.

When diffuse is used, the fresnel and specular colours of the material are overwritten as well.

Q: How to disable diffuse/normal/emissive per Decal?

To disable diffuse just point to a diffuse texture slice (mDiffuseIdx) that is a black and call setIgnoreAlphaDiffuse( true )
To disable normals, just point to a normal map that has XY components set both to 0
To disable emissive, just point to a texture that is black.

Q: Why does it use Metalness? What happens when a non-metallic workflow is used?

Metalness is used for performance reasons, as it allows giving enough control over the specular by just using one parameter, rather than having 3 (one per specular channel)

On metallic & fresnel workflows, this "just works" because the metalness parameter will produce a new coloured F0 parameter, which will overwrite the one from the original material.

On specular workflows, if the fresnel is coloured, it will behave the same way as a metallic/fresnel workflow, because the original specular colour will be set to white, and F0 will be overwritten.

If the fresnel is monochrome (specular workflow), then the specular colour will be overwritten instead, and the metalness value of the decal will act as a fresnel value, overwriting the original fresnel.

Member Typedef Documentation

◆ MovableObjectArray

@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
frustumFrustum to clip against
sceneVisibilityFlagsCombined scene's visibility flags (i.e. viewport | scene). Set LAYER_SHADOW_CASTER bit if you want to exclude non-shadow casters.
outCulledObjectsOut. List of objects that are (fully or partially) inside the frustum and should be rendered
lodCameraCamera 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

Member Enumeration Documentation

◆ Reason

Enumerator
Unknown 
FromStorageToSysRam 

OnStorage -> OnSystemRam.

FromSysRamToStorage 

OnSystemRam -> OnStorage.

GainedResidency 

OnStorage -> Resident OnSystemRam -> Resident See ReadyForRendering.

LostResidency 

Resident -> OnStorage Resident -> OnSystemRam.

PoolTextureSlotChanged 
ResidentToSysRamSync 

Only called while TextureGpu is still Resident, and strategy is AlwaysKeepSystemRamCopy.

This listener happens when something was done to the TextureGpu that modifies its contents in the GPU, and were thus forced to sync those values back to SystemRam. This listener calls tells that sync is over.

MetadataCacheOutOfDate 

The Metadata cache was out of date and we had to do a ping-pong.

Expect this to be followed by at least LostResidency and GainedResidency calls

This is very important, because if you were expecting certain sequence of calls (e.g. you were expecting a LostResidency soon to arrive), expect that to be changed.

See TextureGpuManager for details about the metadata cache.

ExceptionThrown 

Called when the worker thread caught an exception.

This exception has already been logged, and the texture resumed loading normally with a white 2x2 RGBA8 fallback.

This listener will get called from the main thread.

The texture may still have pending residency transitions (e.g. it may still be loading the 2x2 fallback)

Cast Exception e = reinterpret_cast<Exception>( extraData ); to know more info

FsaaSettingAlteredByApi 

Requested FSAA (MSAA / CSAA / EQAA / etc) is not supported by the API, and thus the setting had to be downgraded.

Note this may happen on device lost, and a new GPU became in use; thus it's possible for a TextureGpu to initially support certain FSAA but later change.

ReadyForRendering 

This Reason is called when TextureGpu::notifyDataIsReady is called.

This normally means worker thread is done loading texture from file and uploading it to GPU; and can now be used for rendering. It does NOT mean that Ogre has finished issueing rendering commands to a RenderTexture and is now ready to be presented to the monitor.

Deleted 

Constructor & Destructor Documentation

◆ Decal()

Ogre::Decal::Decal ( IdType  id,
ObjectMemoryManager objectMemoryManager,
SceneManager manager 
)

◆ ~Decal()

virtual Ogre::Decal::~Decal ( )
virtual

Member Function Documentation

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

Referenced by Ogre::PortalBase::_notifyAttached().

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

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

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

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

Reimplemented in Ogre::v1::Rectangle2D.

◆ _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::StaticGeometry::Region, Ogre::ParticleSystem, Ogre::v1::ManualObject, Ogre::Light, Ogre::v1::Entity, Ogre::v1::BillboardSet, Ogre::MovablePlane, and Ogre::v1::BillboardChain.

◆ 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
globalLightListList of lights already culled against all possible frustums and reorganized contiguously for SoA

◆ calculateCameraDistance()

static ArrayReal Ogre::MovableObject::calculateCameraDistance ( uint32  _cameraSortMode,
const ArrayVector3 cameraPos,
const ArrayVector3 cameraDir,
ArrayAabb *RESTRICT_ALIAS  worldAabb,
ArrayReal *RESTRICT_ALIAS  worldRadius 
)
inlinestaticinherited

◆ calculateCastersBox()

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

◆ 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,
uint32  sceneLightMask,
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
outGlobalLightListOutput, a list of lights, contiguously placed
frustumsAn array of all frustums we need to check against
cubemapFrustumsAn 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.

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

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

◆ getCurrentMeshLod()

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

◆ getDefaultLightMask()

static uint32 Ogre::MovableObject::getDefaultLightMask ( )
inlinestaticinherited

Get the default light mask for all future MovableObject instances.

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

◆ getDiffuseTexture()

TextureGpu* Ogre::Decal::getDiffuseTexture ( void  ) const

◆ getEmissiveTexture()

TextureGpu* Ogre::Decal::getEmissiveTexture ( void  ) const

◆ getId()

IdType Ogre::IdObject::getId ( ) const
inlineinherited

Get the unique id of this object.

◆ getIgnoreAlphaDiffuse()

bool Ogre::Decal::getIgnoreAlphaDiffuse ( void  ) const

◆ 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

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

◆ getMetalness()

float Ogre::Decal::getMetalness ( void  ) const
inline

◆ getMovableType()

virtual const String& Ogre::Decal::getMovableType ( void  ) const
virtual

Returns the type name of this object.

Implements Ogre::MovableObject.

◆ getName()

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

Returns the name of this object.

◆ getNormalTexture()

TextureGpu* Ogre::Decal::getNormalTexture ( void  ) const

◆ 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

◆ getQueryFlags()

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

Returns the query flags relevant for this object.

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

◆ getRenderQueueGroup()

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

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

◆ getRoughness()

float Ogre::Decal::getRoughness ( void  ) const
inline

◆ 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

◆ getUserObjectBindings() [1/2]

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

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.

◆ 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

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

◆ isStatic()

bool Ogre::MovableObject::isStatic ( ) const
inherited

Checks whether this MovableObject is static. @See setStatic.

◆ isVisible()

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.

◆ notifyTextureChanged()

virtual void Ogre::Decal::notifyTextureChanged ( TextureGpu texture,
TextureGpuListener::Reason  reason,
void *  extraData 
)
virtual

Called when a TextureGpu changed in a way that affects how it is displayed:

  1. TextureGpu::notifyDataIsReady got called (texture is ready to be displayed)
  2. Texture changed residency status.
  3. Texture is being deleted. It won't be a valid pointer after this call.

Implements Ogre::TextureGpuListener.

◆ 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

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

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

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

◆ setDefaultLightMask()

static void Ogre::MovableObject::setDefaultLightMask ( uint32  mask)
inlinestaticinherited

Set the default light mask for all future MovableObject instances.

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

◆ setDiffuseTexture()

void Ogre::Decal::setDiffuseTexture ( TextureGpu diffuseTex)

Call this family of functions if the input texture is automatically batched We will listen for residency changes and change the internal slice accordingly.

◆ setDiffuseTextureRaw()

void Ogre::Decal::setDiffuseTextureRaw ( TextureGpu diffuseTex,
uint32  sliceIdx 
)

Call this family of functions if the input texture is managed by hand by you.

We will not listen to residency changes. It's your responsibility to ensure the texture resident by the time it needs to be displayed.

◆ setEmissiveTexture()

void Ogre::Decal::setEmissiveTexture ( TextureGpu emissiveTex)

◆ setEmissiveTextureRaw()

void Ogre::Decal::setEmissiveTextureRaw ( TextureGpu emissiveTex,
uint32  sliceIdx 
)

◆ setIgnoreAlphaDiffuse()

void Ogre::Decal::setIgnoreAlphaDiffuse ( bool  bIgnore)

When diffuse textures are used (globally), the alpha component of the diffuse texture will be used to mask all the other textures (e.g.

normal & emissive maps).

When bIgnore = true, the alpha component of the diffuse texture won't be used on normal & emissive maps.

Parameters
bIgnoreTrue to ignore the alpha on the other maps. False otherwise. Default: False

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

◆ setMetalness()

void Ogre::Decal::setMetalness ( float  value)

Value for Metalness. Must be in range [0; 1].

◆ setName()

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

Sets a custom name for this node.

Doesn't have to be unique

◆ setNormalTexture()

void Ogre::Decal::setNormalTexture ( TextureGpu normalTex)

◆ setNormalTextureRaw()

void Ogre::Decal::setNormalTextureRaw ( TextureGpu normalTex,
uint32  sliceIdx 
)

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

◆ setRectSize()

void Ogre::Decal::setRectSize ( Vector2  planeDimensions,
Real  depth 
)

Helper function to set width, height and depth of the decal.

This is a helper function because these parameters actually live in the parent scene node

All the function does is literally:

if( mParentNode )
mParentNode->setScale( planeDimensions.x, depth, planeDimensions.y );
Parameters
planeDimensionsplaneDimensions.x = width planeDimensions.y = height
depthDecals are 2D by nature. The depth of the decal indicates its influence on the objects. Decals are like oriented boxes, and everything inside the box will be affected by the decal.

◆ setRenderingDistance()

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

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

Parameters
distDistance 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
pixelSizeNumber of minimum pixels (the default is 0, which means objects are always rendered).

◆ setRenderQueueGroup()

virtual void Ogre::Decal::setRenderQueueGroup ( uint8  queueID)
virtual

Decals only allow ForwardPlusBase::MinDecalRq <= queueID < ForwardPlusBase::MaxDecalRq.

Reimplemented from Ogre::MovableObject.

◆ setRoughness()

void Ogre::Decal::setRoughness ( float  roughness)

Value for Roughness. Valid range depends on the BRDF used.

◆ setShadowRenderingDistance()

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

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

Parameters
distDistance 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

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

◆ shouldStayLoaded()

virtual bool Ogre::TextureGpuListener::shouldStayLoaded ( TextureGpu texture)
inlinevirtualinherited

Return true if this TextureGpu should likely stay loaded or else graphical changes could occur.

Return false if it is certainly safe to unload.

Reimplemented in Ogre::VctLighting, and Ogre::OGRE_HLMS_TEXTURE_BASE_CLASS.

◆ 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

◆ mDiffuseIdx

uint16 Ogre::Decal::mDiffuseIdx

◆ mEmissiveIdx

uint16 Ogre::Decal::mEmissiveIdx

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

◆ mIgnoreDiffuseAlpha

uint16 Ogre::Decal::mIgnoreDiffuseAlpha

◆ mMetalness

float Ogre::Decal::mMetalness

◆ mNormalMapIdx

uint16 Ogre::Decal::mNormalMapIdx

◆ 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

◆ mRoughness

float Ogre::Decal::mRoughness

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