Ogre Namespace Reference

<

Classes
class	ConfigDialog
	Defines the behaviour of an automatic renderer configuration dialog. More...
class	ErrorDialog
	Class for displaying the error dialog if Ogre fails badly. More...
class	Timer
	Timer class. More...
class	AlignedMemory
	Class to provide aligned memory allocate functionality. More...
class	AnimableValue
	Defines an object property which is animable, i.e. More...
class	AnimableObject
	Defines an interface to classes which have one or more AnimableValue instances to expose. More...
class	Animation
	An animation sequence. More...
class	AnimationState
	Represents the state of an animation and the weight of it's influence. More...
class	AnimationStateSet
	Class encapsulating a set of AnimationState objects. More...
class	AnimationStateControllerValue
	ControllerValue wrapper class for AnimationState. More...
class	TimeIndex
	Time index object used to search keyframe at the given position. More...
class	AnimationTrack
	A 'track' in an animation sequence, i.e. More...
class	NumericAnimationTrack
	Specialised AnimationTrack for dealing with generic animable values. More...
class	NodeAnimationTrack
	Specialised AnimationTrack for dealing with node transforms. More...
class	VertexAnimationTrack
	Specialised AnimationTrack for dealing with changing vertex position information. More...
class	Any
	Variant type that can hold Any other type. More...
class	AnyNumeric
	Specialised Any class which has built in arithmetic operators, but can hold only types which support operator +,-,* and / . More...
struct	FileInfo
	Information about a file/directory within the archive will be returned using a FileInfo struct. More...
class	Archive
	Archive-handling class. More...
class	ArchiveFactory
	Abstract factory class, archive codec plugins can register concrete subclasses of this. More...
class	ArchiveManager
	This class manages the available ArchiveFactory plugins. More...
class	AtomicObject
class	AtomicScalar
class	AutoParamDataSource
	This utility class is used to hold the information used to generate the matrices and other information required to automatically populate GpuProgramParameters. More...
class	AxisAlignedBox
	A 3D box aligned with the x/y/z axes. More...
class	Billboard
	A billboard is a primitive which always faces the camera in every frame. More...
class	BillboardChain
	Allows the rendering of a chain of connected billboards. More...
class	BillboardChainFactory
	Factory object for creating BillboardChain instances. More...
class	BillboardParticleRenderer
	Specialisation of ParticleSystemRenderer to render particles using a BillboardSet. More...
class	BillboardParticleRendererFactory
	Factory class for BillboardParticleRenderer. More...
class	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...
class	BillboardSetFactory
	Factory object for creating BillboardSet instances. More...
class	Bitwise
	Class for manipulating bit patterns. More...
class	LayerBlendModeEx
	Class which manages blending of both colour and alpha components. More...
class	Bone
	A bone in a skeleton. More...
class	BorderPanelOverlayElement
	A specialisation of the PanelOverlayElement to provide a panel with a border. More...
class	BorderRenderable
	Class for rendering the border of a BorderPanelOverlayElement. More...
class	Camera
	A viewpoint from which the scene will be rendered. More...
class	Codec
	Abstract class that defines a 'codec'. More...
class	ColourValue
	Class representing colour. More...
struct	TRect
struct	Box
	Structure used to define a box in a 3-D integer space. More...
class	Compiler2Pass
	Compiler2Pass is a generic 2 pass compiler/assembler. More...
class	CompositionPass
	Object representing one pass or operation in a composition sequence. More...
class	CompositionTargetPass
	Object representing one render to a RenderTarget or Viewport in the Ogre Composition framework. More...
class	CompositionTechnique
	Base composition technique, can be subclassed in plugins. More...
class	Compositor
	Class representing a Compositor object. More...
class	CompositorPtr
	Specialisation of SharedPtr to allow SharedPtr to be assigned to CompositorPtr. More...
class	CompositorChain
	Chain of compositor effects applying to one viewport. More...
class	CompositorInstance
	An instance of a Compositor object for one Viewport. More...
class	CompositorManager
	Class for managing Compositor settings for Ogre. More...
class	CompositorScriptCompiler
	Compiler for parsing & lexing .compositor scripts. More...
class	CompositorScriptCompilerListener
	This is the listener specific to the compositor compiler. More...
class	CompositorScriptCompiler2
	This class uses the new ScriptCompiler to compile compositor scripts. More...
class	CompositorSerializer
	Class for serializing Compositors to / from a .compositor script. More...
class	ConfigFile
	Class for quickly loading settings from a text file. More...
struct	_ConfigOption
	Packages the details of a configuration option. More...
class	ControllerFunction
	Subclasses of this class are responsible for performing a function on an input value for a Controller. More...
class	ControllerValue
	Can either be used as an input or output value. More...
class	Controller
	Instances of this class 'control' the value of another object in the system. More...
class	ControllerManager
	Class for managing Controller instances. More...
class	ConvexBody
	Holds a solid representation of a convex body. More...
class	DataStream
	General purpose class used for encapsulating the reading of data. More...
class	MemoryDataStream
	Common subclass of DataStream for handling data from chunks of memory. More...
class	FileStreamDataStream
	Common subclass of DataStream for handling data from std::basic_istream. More...
class	FileHandleDataStream
	Common subclass of DataStream for handling data from C-style file handles. More...
class	DDSCodec
	Codec specialized in loading DDS (Direct Draw Surface) images. More...
class	DefaultHardwareVertexBuffer
	Specialisation of HardwareVertexBuffer for emulation. More...
class	DefaultHardwareIndexBuffer
	Specialisation of HardwareIndexBuffer for emulation. More...
class	DefaultHardwareBufferManager
	Specialisation of HardwareBufferManager to emulate hardware buffers. More...
class	DynLib
	Resource holding data about a dynamic library. More...
class	DynLibManager
	Manager for Dynamic-loading Libraries. More...
class	EdgeData
	This class contains the information required to describe the edge connectivity of a given set of vertices and indexes. More...
class	EdgeListBuilder
	General utility class for building edge lists for geometry. More...
class	Entity
	Defines an instance of a discrete, movable object based on a Mesh. More...
class	EntityFactory
	Factory object for creating Entity instances. More...
class	Exception
	When thrown, provides information about an error that has occurred inside the engine. More...
struct	ExceptionCodeType
	Template struct which creates a distinct type for each exception code. More...
class	UnimplementedException
class	FileNotFoundException
class	IOException
class	InvalidStateException
class	InvalidParametersException
class	ItemIdentityException
class	InternalErrorException
class	RenderingAPIException
class	RuntimeAssertionException
class	ExceptionFactory
	Class implementing dispatch methods in order to construct by-value exceptions of a derived type based just on an exception code. More...
class	ExternalTextureSource
	IMPORTANT: **Plugins must override default dictionary name!** Base class that texture plugins derive from. More...
class	ExternalTextureSourceManager
	Singleton Class which handles the registering and control of texture plugins. More...
class	FactoryObj
	Abstract factory class. More...
class	FileSystemArchive
	Specialisation of the Archive class to allow reading of files from filesystem folders / directories. More...
class	FileSystemArchiveFactory
	Specialisation of ArchiveFactory for FileSystem files. More...
class	Font
	Class representing a font in the system. More...
class	FontPtr
	Specialisation of SharedPtr to allow SharedPtr to be assigned to FontPtr. More...
class	FontManager
	Manages Font resources, parsing .fontdef files and generally organising them. More...
struct	FrameEvent
	Struct containing information about a frame event. More...
class	FrameListener
	A interface class defining a listener which can be used to receive notifications of frame events. More...
class	FreeImageCodec
	Codec specialized in images loaded using FreeImage. More...
class	Frustum
	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...
struct	GpuConstantDefinition
	Information about predefined program constants. More...
struct	GpuNamedConstants
	Struct collecting together the information for named constants. More...
class	GpuNamedConstantsSerializer
	Simple class for loading / saving GpuNamedConstants. More...
struct	GpuLogicalIndexUse
	Structure recording the use of a physical buffer by a logical parameter index. More...
struct	GpuLogicalBufferStruct
	Container struct to allow params to safely & update shared list of logical buffer assignments. More...
class	GpuProgramParameters
	Collects together the program parameters used for a GpuProgram. More...
class	GpuProgram
	Defines a program which runs on the GPU such as a vertex or fragment program. More...
class	GpuProgramPtr
	Specialisation of SharedPtr to allow SharedPtr to be assigned to GpuProgramPtr. More...
class	GpuProgramManager
class	GpuProgramUsage
	This class makes the usage of a vertex and fragment programs (low-level or high-level), with a given set of parameters, explicit. More...
class	HardwareBuffer
	Abstract class defining common features of hardware buffers. More...
class	HardwareBufferLicensee
	Abstract interface representing a 'licensee' of a hardware buffer copy. More...
class	TempBlendedBufferInfo
	Structure for recording the use of temporary blend buffers. More...
class	HardwareBufferManager
	Abstract singleton class for managing hardware buffers, a concrete instance of this will be created by the RenderSystem. More...
class	HardwareIndexBuffer
	Specialisation of HardwareBuffer for vertex index buffers, still abstract. More...
class	HardwareIndexBufferSharedPtr
	Shared pointer implementation used to share index buffers. More...
class	HardwareOcclusionQuery
	This is a abstract class that that provides the interface for the query class for hardware occlusion. More...
class	HardwarePixelBuffer
	Specialisation of HardwareBuffer for a pixel buffer. More...
class	HardwarePixelBufferSharedPtr
	Shared pointer implementation used to share pixel buffers. More...
class	HardwareVertexBuffer
	Specialisation of HardwareBuffer for a vertex buffer. More...
class	HardwareVertexBufferSharedPtr
	Shared pointer implementation used to share index buffers. More...
class	VertexElement
	This class declares the usage of a single vertex buffer as a component of a complete VertexDeclaration. More...
class	VertexDeclaration
	This class declares the format of a set of vertex inputs, which can be issued to the rendering API through a RenderOperation. More...
class	VertexBufferBinding
	Records the state of all the vertex buffer bindings required to provide a vertex declaration with the input data it needs for the vertex elements. More...
class	HighLevelGpuProgram
	Abstract base class representing a high-level program (a vertex or fragment program). More...
class	HighLevelGpuProgramPtr
	Specialisation of SharedPtr to allow SharedPtr to be assigned to HighLevelGpuProgramPtr. More...
class	HighLevelGpuProgramFactory
	Interface definition for factories of HighLevelGpuProgram. More...
class	HighLevelGpuProgramManager
	This ResourceManager manages high-level vertex and fragment programs. More...
class	ILCodecs
class	ILImageCodec
	Codec specialized in images loaded using DevIL. More...
class	ILUtil
class	Image
	Class representing an image file. More...
class	ImageCodec
	Codec specialized in images. More...
class	InstancedGeometry
	Pre-transforms and batches up meshes for efficient use as instanced geometry in a scene. More...
class	VectorIterator
	Wraps iteration over a vector. More...
class	MapIterator
	Wraps iteration over a map. More...
class	ConstVectorIterator
	Wraps iteration over a const vector. More...
class	ConstMapIterator
	Wraps iteration over a const map. More...
class	KeyFrame
	A key frame in an animation sequence defined by an AnimationTrack. More...
class	NumericKeyFrame
	Specialised KeyFrame which stores any numeric value. More...
class	TransformKeyFrame
	Specialised KeyFrame which stores a full transform. More...
class	VertexMorphKeyFrame
	Specialised KeyFrame which stores absolute vertex positions for a complete buffer, designed to be interpolated with other keys in the same track. More...
class	VertexPoseKeyFrame
	Specialised KeyFrame which references a Mesh::Pose at a certain influence level, which stores offsets for a subset of the vertices in a buffer to provide a blendable pose. More...
class	Light
	Representation of a dynamic light source in the scene. More...
class	LightFactory
	Factory object for creating Light instances. More...
class	LogListener
	Remarks: Pure Abstract class, derive this class and register to the Log to listen to log messages More...
class	Log
	Remarks: Log class for writing debug/log data to files. More...
class	LogManager
	The log manager handles the creation and retrieval of logs for the application. More...
class	ManualObject
	Class providing a much simplified interface to generating manual objects with custom geometry. More...
class	ManualObjectFactory
	Factory object for creating ManualObject instances. More...
class	Material
	Class encapsulates rendering properties of an object. More...
class	MaterialPtr
	Specialisation of SharedPtr to allow SharedPtr to be assigned to MaterialPtr. More...
class	MaterialManager
	Class for managing Material settings for Ogre. More...
struct	MaterialScriptProgramDefinition
	Struct for holding a program definition which is in progress. More...
struct	MaterialScriptContext
	Struct for holding the script context while parsing. More...
class	MaterialSerializer
	Class for serializing Materials to / from a .material script. More...
class	Radian
	Wrapper class which indicates a given angle value is in Radians. More...
class	Degree
	Wrapper class which indicates a given angle value is in Degrees. More...
class	Angle
	Wrapper class which identifies a value as the currently default angle type, as defined by Math::setAngleUnit. More...
class	Math
	Class to provide access to common mathematical functions. More...
class	Matrix3
	A 3x3 matrix which can represent rotations around axes. More...
class	Matrix4
	Class encapsulating a standard 4x4 homogeneous matrix. More...
class	AllocatedObject
	Superclass for all objects that wish to use custom memory allocators when their new / delete operators are called. More...
class	CategorisedAllocPolicy
class	CategorisedAlignAllocPolicy
class	NedAllocPolicy
	An allocation policy for use with AllocatedObject and STLAllocator. More...
class	NedAlignedAllocPolicy
	An allocation policy for use with AllocatedObject and STLAllocator, which aligns memory at a given boundary (which should be a power of 2). More...
class	StdAllocPolicy
	A "standard" allocation policy for use with AllocatedObject and STLAllocator. More...
class	StdAlignedAllocPolicy
	A "standard" allocation policy for use with AllocatedObject and STLAllocator, which aligns memory at a given boundary (which should be a power of 2). More...
class	STLAllocator
	Wrapper class for operating as an STL container allocator. More...
class	Mesh
class	MeshPtr
	Specialisation of SharedPtr to allow SharedPtr to be assigned to MeshPtr. More...
struct	MeshLodUsage
	A way of recording the way each LODs is recorded this Mesh. More...
class	MeshManager
	Handles the management of mesh resources. More...
class	MeshSerializer
	Class for serialising mesh data to/from an OGRE .mesh file. More...
class	MeshSerializerListener
	Remarks: This class allows users to hook into the mesh loading process and modify references within the mesh as they are loading. More...
class	MeshSerializerImpl
	Internal implementation of Mesh reading / writing for the latest version of the .mesh format. More...
class	MeshSerializerImpl_v1_3
	Class for providing backwards-compatibility for loading version 1.3 of the .mesh format. More...
class	MeshSerializerImpl_v1_2
	Class for providing backwards-compatibility for loading version 1.2 of the .mesh format. More...
class	MeshSerializerImpl_v1_1
	Class for providing backwards-compatibility for loading version 1.1 of the .mesh format. More...
class	MovableObject
	Abstract class defining a movable object in a scene. More...
class	MovableObjectFactory
	Interface definition for a factory class which produces a certain kind of MovableObject, and can be registered with Root in order to allow all clients to produce new instances of this object, integrated with the standard Ogre processing. More...
class	MovablePlane
	Definition of a Plane that may be attached to a node, and the derived details of it retrieved simply. More...
class	Node
	Class representing a general-purpose node an articulated scene graph. More...
class	NumericSolver
	Provides numeric solvers for Ogre. More...
class	OptimisedUtil
	Utility class for provides optimised functions. More...
class	Overlay
	Represents a layer which is rendered on top of the 'normal' scene contents. More...
class	OverlayContainer
	A 2D element which contains other OverlayElement instances. More...
class	OverlayElement
	Abstract definition of a 2D element to be displayed in an Overlay. More...
class	OverlayElementFactory
	Defines the interface which all components wishing to supply OverlayElement subclasses must implement. More...
class	PanelOverlayElementFactory
	Factory for creating PanelOverlayElement instances. More...
class	BorderPanelOverlayElementFactory
	Factory for creating BorderPanelOverlayElement instances. More...
class	TextAreaOverlayElementFactory
	Factory for creating TextAreaOverlayElement instances. More...
class	OverlayManager
	Manages Overlay objects, parsing them from .overlay files and storing a lookup library of them. More...
class	PanelOverlayElement
	OverlayElement representing a flat, single-material (or transparent) panel which can contain other elements. More...
class	ParticleVisualData
	Abstract class containing any additional data required to be associated with a particle to perform the required rendering. More...
class	Particle
	Class representing a single particle instance. More...
class	ParticleAffector
	Abstract class defining the interface to be implemented by particle affectors. More...
class	ParticleAffectorFactory
	Abstract class defining the interface to be implemented by creators of ParticleAffector subclasses. More...
class	ParticleEmitter
	Abstract class defining the interface to be implemented by particle emitters. More...
class	ParticleEmitterFactory
	Abstract class defining the interface to be implemented by creators of ParticleEmitter subclasses. More...
class	ParticleIterator
	Convenience class to make it easy to step through all particles in a ParticleSystem. More...
class	ParticleScriptCompilerListener
	This is the specific listener for the particle script compiler. More...
class	ParticleScriptCompiler
class	ParticleSystem
	Class defining particle system based special effects. More...
class	ParticleSystemManager
	Manages particle systems, particle system scripts (templates) and the available emitter & affector factories. More...
class	ParticleSystemFactory
	Factory object for creating ParticleSystem instances. More...
class	ParticleSystemRenderer
	Abstract class defining the interface required to be implemented by classes which provide rendering capability to ParticleSystem instances. More...
class	ParticleSystemRendererFactory
	Abstract class definition of a factory object for ParticleSystemRenderer. More...
class	Pass
	Class defining a single pass of a Technique (of a Material), i.e. More...
struct	IlluminationPass
	Struct recording a pass which can be used for a specific illumination stage. More...
class	PatchMesh
	Patch specialisation of Mesh. More...
class	PatchMeshPtr
	Specialisation of SharedPtr to allow SharedPtr to be assigned to PatchMeshPtr. More...
class	PatchSurface
	A surface which is defined by curves of some kind to form a patch, e.g. More...
class	PixelBox
	A primitive describing a volume (3D), image (2D) or line (1D) of pixels in memory. More...
class	PixelUtil
	Some utility functions for packing and unpacking pixel data. More...
class	Plane
	Defines a plane in 3D space. More...
class	PlaneBoundedVolume
	Represents a convex volume bounded by planes. More...
class	PlatformInformation
	Class which provides the run-time platform information Ogre runs on. More...
class	Plugin
	Class defining a generic OGRE plugin. More...
class	Polygon
	The class represents a polygon in 3D space. More...
class	Pose
	A pose is a linked set of vertex offsets applying to one set of vertex data. More...
class	FrameTimeControllerValue
	Predefined controller value for getting the latest frame time. More...
class	TextureFrameControllerValue
	Predefined controller value for getting / setting the frame number of a texture layer. More...
class	TexCoordModifierControllerValue
	Predefined controller value for getting / setting a texture coordinate modifications (scales and translates). More...
class	FloatGpuParameterControllerValue
	Predefined controller value for setting a single floating- point value in a constant parameter of a vertex or fragment program. More...
class	PassthroughControllerFunction
	Predefined controller function which just passes through the original source directly to dest. More...
class	AnimationControllerFunction
	Predefined controller function for dealing with animation. More...
class	ScaleControllerFunction
	Predefined controller function which simply scales an input to an output value. More...
class	WaveformControllerFunction
	Predefined controller function based on a waveform. More...
class	PrefabFactory
	A factory class that can create various mesh prefabs. More...
class	Profile
	An individual profile that will be processed by the Profiler. More...
class	Profiler
	The profiler allows you to measure the performance of your code. More...
class	ProgressiveMesh
	This class reduces the complexity of the geometry it is given. More...
class	Quaternion
	Implementation of a Quaternion, i.e. More...
class	RadixSort
	Class for performing a radix sort (fast comparison-less sort based on byte value) on various standard STL containers. More...
class	Ray
	Representation of a ray in space, i.e. More...
struct	Rectangle
class	Rectangle2D
	Allows the rendering of a simple 2D rectangle This class renders a simple 2D rectangle; this rectangle has no depth and therefore is best used with specific render queue and depth settings, like RENDER_QUEUE_BACKGROUND and 'depth_write off' for backdrops, and RENDER_QUEUE_OVERLAY and 'depth_check off' for fullscreen quads. More...
class	Renderable
	Abstract class defining the interface all renderable objects must implement. More...
class	RenderOperation
	'New' rendering operation using vertex buffers. More...
class	RenderQueue
	Class to manage the scene object rendering queue. More...
class	RenderQueueInvocation
	Class representing the invocation of queue groups in a RenderQueue. More...
class	RenderQueueInvocationSequence
	Class to hold a linear sequence of RenderQueueInvocation objects. More...
class	RenderQueueListener
	Abstract interface which classes must implement if they wish to receive events from the render queue. More...
struct	RenderablePass
	Struct associating a single Pass with a single Renderable. More...
class	QueuedRenderableVisitor
	Visitor interface for items in a QueuedRenderableCollection. More...
class	QueuedRenderableCollection
	Lowest level collection of renderables. More...
class	RenderPriorityGroup
	Collection of renderables by priority. More...
class	RenderQueueGroup
	A grouping level underneath RenderQueue which groups renderables to be issued at coarsely the same time to the renderer. More...
class	RenderSystem
	Defines the functionality of a 3D API. More...
struct	DriverVersion
	DriverVersion is used by RenderSystemCapabilities and both GL and D3D9 to store the version of the current GPU driver. More...
class	RenderSystemCapabilities
	singleton class for storing the capabilities of the graphics card. More...
class	RenderSystemCapabilitiesManager
	Class for managing RenderSystemCapabilities database for Ogre. More...
class	RenderSystemCapabilitiesSerializer
	Class for serializing RenderSystemCapabilities to / from a .rendercaps script. More...
class	RenderTarget
	A 'canvas' which can receive the results of a rendering operation. More...
struct	RenderTargetEvent
	Struct containing information about a RenderTarget event. More...
struct	RenderTargetViewportEvent
	Struct containing information about a RenderTarget Viewport-specific event. More...
class	RenderTargetListener
	A interface class defining a listener which can be used to receive notifications of RenderTarget events. More...
class	RenderTexture
	This class represents a RenderTarget that renders to a Texture. More...
class	MultiRenderTarget
	This class represents a render target that renders to multiple RenderTextures at once. More...
class	RenderToVertexBuffer
	An object which renders geometry to a vertex. More...
class	RenderWindow
	Manages the target rendering window. More...
class	Resource
	Abstract class representing a loadable resource (e.g. More...
class	ManualResourceLoader
	Interface describing a manual resource loader. More...
struct	BackgroundProcessResult
	Encapsulates the result of a background queue request. More...
class	ResourceBackgroundQueue
	This class is used to perform Resource operations in a background thread. More...
class	ResourceGroupListener
	This abstract class defines an interface which is called back during resource group loading to indicate the progress of the load. More...
class	ResourceLoadingListener
	Remarks: This class allows users to override resource loading behavior. More...
class	ResourceGroupManager
	This singleton class manages the list of resource groups, and notifying the various resource managers of their obligations to load / unload resources in a group. More...
class	ResourceManager
	Defines a generic resource handler. More...
class	RibbonTrail
	Subclass of BillboardChain which automatically leaves a trail behind one or more Node instances. More...
class	RibbonTrailFactory
	Factory object for creating RibbonTrail instances. More...
class	Root
	The root class of the Ogre system. More...