Namespaces | Classes | Enumerations | Variables
Effects
Collaboration diagram for Effects:

Namespaces

 Ogre::EmitterCommands
 

Classes

class  Ogre::Billboard
 A billboard is a primitive which always faces the camera in every frame. More...
 
class  Ogre::BillboardChain
 Allows the rendering of a chain of connected billboards. More...
 
struct  Ogre::BillboardChain::ChainSegment
 Simple struct defining a chain segment by referencing a subset of the preallocated buffer (which will be mMaxElementsPerChain * mChainCount long), by it's chain index, and a head and tail value which describe the current chain. More...
 
class  Ogre::BillboardChain::Element
 Contains the data of an element of the BillboardChain. More...
 
class  Ogre::BillboardChainFactory
 Factory object for creating BillboardChain instances. More...
 
class  Ogre::BillboardParticleRenderer
 Specialisation of ParticleSystemRenderer to render particles using a BillboardSet. More...
 
class  Ogre::BillboardParticleRenderer::CmdAccurateFacing
 Command object for accurate facing(see ParamCommand). More...
 
class  Ogre::BillboardParticleRenderer::CmdBillboardOrigin
 Command object for billboard origin (see ParamCommand). More...
 
class  Ogre::BillboardParticleRenderer::CmdBillboardRotationType
 Command object for billboard rotation type (see ParamCommand). More...
 
class  Ogre::BillboardParticleRenderer::CmdBillboardType
 Command object for billboard type (see ParamCommand). More...
 
class  Ogre::BillboardParticleRenderer::CmdCommonDirection
 Command object for common direction (see ParamCommand). More...
 
class  Ogre::BillboardParticleRenderer::CmdCommonUpVector
 Command object for common up-vector (see ParamCommand). More...
 
class  Ogre::BillboardParticleRenderer::CmdPointRendering
 Command object for point rendering (see ParamCommand). More...
 
class  Ogre::BillboardParticleRendererFactory
 Factory class for BillboardParticleRenderer. More...
 
class  Ogre::BillboardSet
 A collection of billboards (faces which are always facing the given direction) with the same (default) dimensions, material and which are fairly close proximity to each other. More...
 
struct  Ogre::BillboardSet::SortByDirectionFunctor
 Sort by direction functor. More...
 
struct  Ogre::BillboardSet::SortByDistanceFunctor
 Sort by distance functor. More...
 
class  Ogre::BillboardSetFactory
 Factory object for creating BillboardSet instances. More...
 
class  Ogre::CompositionPass
 Object representing one pass or operation in a composition sequence. More...
 
struct  Ogre::CompositionPass::InputTex
 Inputs (for material used for rendering the quad) More...
 
class  Ogre::CompositionTargetPass
 Object representing one render to a RenderTarget or Viewport in the Ogre Composition framework. More...
 
class  Ogre::CompositionTechnique
 Base composition technique, can be subclassed in plugins. More...
 
class  Ogre::CompositionTechnique::TextureDefinition
 Local texture definition. More...
 
class  Ogre::Compositor
 Class representing a Compositor object. More...
 
class  Ogre::CompositorChain
 Chain of compositor effects applying to one viewport. More...
 
class  Ogre::CompositorChain::RQListener
 Render queue listener used to set up rendering events. More...
 
class  Ogre::CompositorInstance
 An instance of a Compositor object for one Viewport. More...
 
class  Ogre::CompositorInstance::Listener
 Provides an interface to "listen in" to to render system operations executed by this CompositorInstance. More...
 
class  Ogre::CompositorInstance::RenderSystemOperation
 Specific render system operation. More...
 
class  Ogre::CompositorInstance::TargetOperation
 Operation setup for a RenderTarget (collected). More...
 
class  Ogre::CompositorLogic
 Interface for compositor logics, which can be automatically binded to compositors, allowing per-compositor logic (such as attaching a relevant listener) to happen automatically. More...
 
class  Ogre::CompositorManager
 Class for managing Compositor settings for Ogre. More...
 
struct  Ogre::CompositorManager::TextureDef
 
struct  Ogre::CompositorManager::TextureDefLess
 
class  Ogre::CustomCompositionPass
 Interface for custom composition passes, allowing custom operations (in addition to the quad, scene and clear operations) in composition passes. More...
 
class  Ogre::EmitterCommands::CmdAngle
 Command object for ParticleEmitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdColour
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdColourRangeEnd
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdColourRangeStart
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdDirection
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdDirPositionRef
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdDuration
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdEmissionRate
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdEmittedEmitter
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdMaxDuration
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdMaxRepeatDelay
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdMaxTTL
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdMaxVelocity
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdMinDuration
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdMinRepeatDelay
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdMinTTL
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdMinVelocity
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdName
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdPosition
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdRepeatDelay
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdTTL
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdUp
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::EmitterCommands::CmdVelocity
 Command object for particle emitter - see ParamCommand. More...
 
class  Ogre::Particle
 Class representing a single particle instance. More...
 
class  Ogre::ParticleAffector
 Abstract class defining the interface to be implemented by particle affectors. More...
 
class  Ogre::ParticleAffectorFactory
 Abstract class defining the interface to be implemented by creators of ParticleAffector subclasses. More...
 
class  Ogre::ParticleEmitter
 Abstract class defining the interface to be implemented by particle emitters. More...
 
class  Ogre::ParticleEmitterFactory
 Abstract class defining the interface to be implemented by creators of ParticleEmitter subclasses. More...
 
class  Ogre::ParticleIterator
 Convenience class to make it easy to step through all particles in a ParticleSystem. More...
 
class  Ogre::ParticleSystem
 Class defining particle system based special effects. More...
 
class  Ogre::ParticleSystem::CmdCull
 Command object for cull_each (see ParamCommand). More...
 
class  Ogre::ParticleSystem::CmdEmittedEmitterQuota
 Command object for emittedEmitterQuota (see ParamCommand). More...
 
class  Ogre::ParticleSystem::CmdHeight
 Command object for particle_height (see ParamCommand). More...
 
class  Ogre::ParticleSystem::CmdIterationInterval
 Command object for iteration interval(see ParamCommand). More...
 
class  Ogre::ParticleSystem::CmdLocalSpace
 Command object for local space (see ParamCommand). More...
 
class  Ogre::ParticleSystem::CmdMaterial
 Command object for material (see ParamCommand). More...
 
class  Ogre::ParticleSystem::CmdNonvisibleTimeout
 Command object for nonvisible timeout (see ParamCommand). More...
 
class  Ogre::ParticleSystem::CmdQuota
 Command object for quota (see ParamCommand). More...
 
class  Ogre::ParticleSystem::CmdRenderer
 Command object for renderer (see ParamCommand). More...
 
class  Ogre::ParticleSystem::CmdSorted
 Command object for sorting (see ParamCommand). More...
 
class  Ogre::ParticleSystem::CmdWidth
 Command object for particle_width (see ParamCommand). More...
 
class  Ogre::ParticleSystemFactory
 Factory object for creating ParticleSystem instances. More...
 
class  Ogre::ParticleSystemManager
 Manages particle systems, particle system scripts (templates) and the available emitter & affector factories. More...
 
class  Ogre::ParticleSystemRenderer
 Abstract class defining the interface required to be implemented by classes which provide rendering capability to ParticleSystem instances. More...
 
class  Ogre::ParticleSystemRendererFactory
 Abstract class definition of a factory object for ParticleSystemRenderer. More...
 
class  Ogre::ParticleVisualData
 Abstract class containing any additional data required to be associated with a particle to perform the required rendering. More...
 
class  Ogre::RibbonTrail
 Subclass of BillboardChain which automatically leaves a trail behind one or more Node instances. More...
 
class  Ogre::RibbonTrailFactory
 Factory object for creating RibbonTrail instances. More...
 

Enumerations

enum  Ogre::BillboardOrigin {
  Ogre::BBO_TOP_LEFT, Ogre::BBO_TOP_CENTER, Ogre::BBO_TOP_RIGHT, Ogre::BBO_CENTER_LEFT,
  Ogre::BBO_CENTER, Ogre::BBO_CENTER_RIGHT, Ogre::BBO_BOTTOM_LEFT, Ogre::BBO_BOTTOM_CENTER,
  Ogre::BBO_BOTTOM_RIGHT
}
 Enum covering what exactly a billboard's position means (center, top-left etc). More...
 
enum  Ogre::BillboardRotationType { Ogre::BBR_VERTEX, Ogre::BBR_TEXCOORD }
 The rotation type of billboard. More...
 
enum  Ogre::BillboardType {
  Ogre::BBT_POINT, Ogre::BBT_ORIENTED_COMMON, Ogre::BBT_ORIENTED_SELF, Ogre::BBT_PERPENDICULAR_COMMON,
  Ogre::BBT_PERPENDICULAR_SELF
}
 The type of billboard to use. More...
 
enum  Ogre::CompositionTargetPass::InputMode { Ogre::CompositionTargetPass::IM_NONE, Ogre::CompositionTargetPass::IM_PREVIOUS }
 Input mode of a TargetPass. More...
 
enum  Ogre::Particle::ParticleType { Ogre::Particle::Visual, Ogre::Particle::Emitter }
 Type of particle. More...
 
enum  Ogre::CompositionPass::PassType {
  Ogre::CompositionPass::PT_CLEAR, Ogre::CompositionPass::PT_STENCIL, Ogre::CompositionPass::PT_RENDERSCENE, Ogre::CompositionPass::PT_RENDERQUAD,
  Ogre::CompositionPass::PT_RENDERCUSTOM
}
 Enumeration that enumerates the various composition pass types. More...
 
enum  Ogre::BillboardChain::TexCoordDirection { Ogre::BillboardChain::TCD_U, Ogre::BillboardChain::TCD_V }
 The direction in which texture coordinates from elements of the chain are used. More...
 
enum  Ogre::CompositionTechnique::TextureScope { Ogre::CompositionTechnique::TS_LOCAL, Ogre::CompositionTechnique::TS_CHAIN, Ogre::CompositionTechnique::TS_GLOBAL }
 

Variables

const size_t Ogre::RENDER_QUEUE_COUNT = RENDER_QUEUE_MAX+1
 

Detailed Description

Enumeration Type Documentation

Enum covering what exactly a billboard's position means (center, top-left etc).

See also
BillboardSet::setBillboardOrigin
Enumerator
BBO_TOP_LEFT 
BBO_TOP_CENTER 
BBO_TOP_RIGHT 
BBO_CENTER_LEFT 
BBO_CENTER 
BBO_CENTER_RIGHT 
BBO_BOTTOM_LEFT 
BBO_BOTTOM_CENTER 
BBO_BOTTOM_RIGHT 

Definition at line 54 of file OgreBillboardSet.h.

The rotation type of billboard.

Enumerator
BBR_VERTEX 

Rotate the billboard's vertices around their facing direction.

BBR_TEXCOORD 

Rotate the billboard's texture coordinates.

Definition at line 67 of file OgreBillboardSet.h.

The type of billboard to use.

Enumerator
BBT_POINT 

Standard point billboard (default), always faces the camera completely and is always upright.

BBT_ORIENTED_COMMON 

Billboards are oriented around a shared direction vector (used as Y axis) and only rotate around this to face the camera.

BBT_ORIENTED_SELF 

Billboards are oriented around their own direction vector (their own Y axis) and only rotate around this to face the camera.

BBT_PERPENDICULAR_COMMON 

Billboards are perpendicular to a shared direction vector (used as Z axis, the facing direction) and X, Y axis are determined by a shared up-vertor.

BBT_PERPENDICULAR_SELF 

Billboards are perpendicular to their own direction vector (their own Z axis, the facing direction) and X, Y axis are determined by a shared up-vertor.

Definition at line 75 of file OgreBillboardSet.h.

Input mode of a TargetPass.

Enumerator
IM_NONE 
IM_PREVIOUS 

No input.

Output of previous Composition in chain

Definition at line 53 of file OgreCompositionTargetPass.h.

Type of particle.

Enumerator
Visual 
Emitter 

Definition at line 70 of file OgreParticle.h.

Enumeration that enumerates the various composition pass types.

Enumerator
PT_CLEAR 
PT_STENCIL 

Clear target to one colour.

PT_RENDERSCENE 

Set stencil operation.

PT_RENDERQUAD 

Render the scene or part of it.

PT_RENDERCUSTOM 

Render a full screen quad.

Render a custom sequence

Definition at line 55 of file OgreCompositionPass.h.

The direction in which texture coordinates from elements of the chain are used.

Enumerator
TCD_U 

Tex coord in elements is treated as the 'u' texture coordinate.

TCD_V 

Tex coord in elements is treated as the 'v' texture coordinate.

Definition at line 151 of file OgreBillboardChain.h.

Enumerator
TS_LOCAL 
TS_CHAIN 
TS_GLOBAL 

Definition at line 52 of file OgreCompositionTechnique.h.

Variable Documentation

const size_t Ogre::RENDER_QUEUE_COUNT = RENDER_QUEUE_MAX+1

Definition at line 45 of file OgreCompositorInstance.h.


Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sat Oct 25 2014 14:52:03