ignition::rendering Namespace Reference
Classes | |
| class | ArrowVisual |
| Represents a arrow composite visual. More... | |
| class | AxisVisual |
| Represents a axis composite visual. More... | |
| class | BaseArrowVisual |
| class | BaseAxisVisual |
| class | BaseCamera |
| class | BaseCompositeStore |
| class | BaseDirectionalLight |
| class | BaseGeometry |
| class | BaseGeometryStore |
| class | BaseGrid |
| Base implementation of a grid geometry. More... | |
| class | BaseLight |
| class | BaseLightStore |
| class | BaseMap |
| class | BaseMaterial |
| class | BaseMaterialMap |
| class | BaseMesh |
| class | BaseNode |
| class | BaseNodeCompositeStore |
| class | BaseNodeStore |
| class | BaseObject |
| class | BasePointLight |
| class | BaseRayQuery |
| A Ray Query class used for computing ray object intersections. More... | |
| class | BaseRenderEngine |
| class | BaseRenderTarget |
| class | BaseRenderTexture |
| class | BaseRenderWindow |
| class | BaseScene |
| class | BaseSceneStore |
| class | BaseSensor |
| class | BaseSensorStore |
| class | BaseSpotLight |
| class | BaseStore |
| class | BaseStoreWrapper |
| class | BaseSubMesh |
| class | BaseSubMeshStore |
| class | BaseVisual |
| class | BaseVisualStore |
| class | Camera |
| Posable camera used for rendering the scene graph. More... | |
| class | CompositeStore |
| Represents a collection of Store objects, collectively working as a single composite store. More... | |
| class | CompositeVisual |
| Represents a predefined collection of geometries and visuals. More... | |
| class | DirectionalLight |
| Represents a infinite directional light. More... | |
| class | Geometry |
| Represents a geometric shape to be rendered. More... | |
| class | Grid |
| Represents a grid geometry drawn along the XY plane. If vertical cell count is specified then the grid becomes 3D. More... | |
| class | Image |
| Encapsulates a raw image buffer and relevant properties. More... | |
| class | Light |
| Represents a light source in the scene graph. More... | |
| class | Map |
| Storage map from std::string to template class T. More... | |
| class | Material |
| Represents a surface material of a Geometry. More... | |
| class | Mesh |
| Represents a collection of mesh geometries. More... | |
| struct | MeshDescriptor |
| Describes how a Mesh should be loaded. More... | |
| class | Node |
| Represents a single posable node in the scene graph. More... | |
| class | Object |
| Represents an object present in the scene graph. This includes sub-meshes, materials, render targets, as well as posable nodes. More... | |
| class | OgreArrowVisual |
| class | OgreAxisVisual |
| class | OgreCamera |
| class | OgreConversions |
| Conversions Conversions.hh rendering/Conversions.hh. More... | |
| class | OgreDirectionalLight |
| class | OgreGeometry |
| class | OgreGrid |
| Ogre implementation of a grid geometry. More... | |
| class | OgreLight |
| class | OgreMaterial |
| class | OgreMesh |
| class | OgreMeshFactory |
| class | OgreNode |
| class | OgreObject |
| class | OgrePointLight |
| class | OgreRayQuery |
| A Ray Query class used for computing ray object intersections. More... | |
| class | OgreRenderEngine |
| class | OgreRenderEnginePlugin |
| Plugin for loading ogre render engine. More... | |
| class | OgreRenderTarget |
| class | OgreRenderTexture |
| class | OgreRenderWindow |
| class | OgreRTShaderSystem |
| Implements Ogre's Run-Time Shader system. More... | |
| class | OgreScene |
| class | OgreSensor |
| class | OgreSpotLight |
| class | OgreSubMesh |
| class | OgreSubMeshStoreFactory |
| class | OgreVisual |
| class | OrbitViewController |
| A camera view controller. More... | |
| class | PixelUtil |
| Provides supporting functions for PixelFormat enum. More... | |
| class | PointLight |
| Represents a point light. More... | |
| class | RayQuery |
| A Ray Query class used for computing ray object intersections. More... | |
| class | RayQueryResult |
| A class that stores ray query intersection results. More... | |
| class | RenderEngine |
| An abstract interface to a concrete render-engine. A RenderEngine is responsible for initializing a render-engine as well as creating, storing, and destroying scenes. More... | |
| class | RenderEngineManager |
| Collection of render-engines. This provides access to all the render-engines available at runtime. RenderEngine objects should not be access directly, but instead via the RenderEngineManager to maintain a flexible render-engine agnostic design. More... | |
| class | RenderEnginePlugin |
| Base plugin class for render engines. More... | |
| class | RenderTarget |
| Represents a render-target to which cameras can render images. More... | |
| class | RenderTexture |
| Represents a off-screen render-texture to which cameras can render images. More... | |
| class | RenderWindow |
| Represents a on-screen render-window to which cameras can render images. More... | |
| class | Scene |
| Manages a single scene-graph. This class updates scene-wide properties and holds the root scene node. A Scene also serves as a factory for all scene objects. More... | |
| class | Sensor |
| Represents a scene sensor. The most obvious example is a camera, but it can be anything that generates output from the scene. More... | |
| class | ShaderUtil |
| Provides supporting functions for ShaderType enum. More... | |
| class | SpotLight |
| Represents a spotlight. More... | |
| class | Store |
| Multi-access storage structure of template class T. Template class T is expected to have functions GetId, GetName(), Destroy() which return unsigned int, std::string, and void respectively. This store will ensure that each element's name and ID are unique. More... | |
| class | StoreWrapper |
| Simple wrapper class that allows a Store of type Derived to be treated as a Store of type Base, where Derived is some class derived from Base. This is useful in storing Stores of different derived types in a single CompositeStore instance. More... | |
| class | SubMesh |
| Represents a single mesh geometry. More... | |
| class | ViewController |
| A camera view controller. More... | |
| class | Visual |
| Represents a visual node in a scene graph. A Visual is the only node that can have Geometry and other Visual children. More... | |
Enumerations | |
| enum | PixelFormat { PF_UNKNOWN = 0, PF_L8 = 1, PF_R8G8B8 = 2, PF_B8G8R8 = 3, PF_BAYER_RGGB8 = 4, PF_BAYER_BGGR8 = 5, PF_BAYER_GBGR8 = 6, PF_BAYER_GRGB8 = 7, PF_COUNT = 8 } |
| enum | ShaderType { ST_UNKNOWN = 0, ST_PIXEL = 1, ST_VERTEX = 2, ST_NORM_OBJ = 3, ST_NORM_TAN = 4, ST_COUNT = 5 } |
| Available types of shaders. Note that not all rendering-engines will be able to use each type. They will instead default to the closest alternative. More... | |
Functions | |
| RenderEngine * | engine (const std::string &_name) |
| Get the render-engine registered under the given name. If no render-engine is registered under the given name, NULL will be returned. More... | |
| RenderEngine * | engine (const unsigned int _index) |
| Get the render-engine registered at the given index. If no render-engine is registered at the given index, NULL will be returned. More... | |
| unsigned int | engineCount () |
| Get the number of available render-engines. More... | |
| bool | fini () |
| Destroy all render-engines and related resources. More... | |
| bool | hasEngine (const std::string &_name) |
| Determine if a render-engine is registered under the given name. More... | |
| bool | init () |
| Initialized shared render-engine features. More... | |
| bool | load () |
| Load shared render-engine resources. More... | |
| void | registerEngine (const std::string &_name, RenderEngine *_engine) |
| Register a new render-engine under the given name. If the given name is already in use, the render-engine will not be registered. More... | |
| void | unregisterEngine (const std::string &_name) |
| Unregister a render-engine registered under the given name. If the no render-engine is registered under the given name no work will be done. More... | |
| void | unregisterEngine (RenderEngine *_engine) |
| Unregister the given render-engine. If the given render-engine is not currently registered, no work will be done. More... | |
| void | unregisterEngine (const unsigned int _index) |
| Unregister a render-engine at the given index. If the no render-engine is registered at the given index, no work will be done. More... | |
Typedef Documentation
◆ ArrowVisualPtr
| typedef shared_ptr<ArrowVisual> ArrowVisualPtr |
◆ AxisVisualPtr
| typedef shared_ptr<AxisVisual> AxisVisualPtr |
◆ BaseNodeCompositeStorePtr
◆ CameraPtr
| typedef shared_ptr<Camera> CameraPtr |
◆ ConstArrowVisualPtr
| typedef shared_ptr<const ArrowVisual> ConstArrowVisualPtr |
◆ ConstAxisVisualPtr
| typedef shared_ptr<const AxisVisual> ConstAxisVisualPtr |
◆ ConstCameraPtr
| typedef shared_ptr<const Camera> ConstCameraPtr |
◆ ConstDirectionalLightPtr
| typedef shared_ptr<const DirectionalLight> ConstDirectionalLightPtr |
◆ ConstGeometryPtr
| typedef shared_ptr<const Geometry> ConstGeometryPtr |
◆ ConstImagePtr
| typedef shared_ptr<const Image> ConstImagePtr |
◆ ConstJointVisualPtr
| typedef shared_ptr<const JointVisual> ConstJointVisualPtr |
◆ ConstLightPtr
| typedef shared_ptr<const Light> ConstLightPtr |
◆ ConstMaterialPtr
| typedef shared_ptr<const Material> ConstMaterialPtr |
◆ ConstMeshPtr
| typedef shared_ptr<const Mesh> ConstMeshPtr |
◆ ConstNodePtr
| typedef shared_ptr<const Node> ConstNodePtr |
◆ ConstObjectFactoryPtr
| typedef shared_ptr<const ObjectFactory> ConstObjectFactoryPtr |
◆ ConstObjectPtr
| typedef shared_ptr<const Object> ConstObjectPtr |
◆ ConstPointLightPtr
| typedef shared_ptr<const PointLight> ConstPointLightPtr |
◆ ConstRayQuery
| typedef shared_ptr<const RayQuery> ConstRayQuery |
◆ ConstRenderTargetPtr
| typedef shared_ptr<const RenderTarget> ConstRenderTargetPtr |
◆ ConstRenderTexturePtr
| typedef shared_ptr<const RenderTexture> ConstRenderTexturePtr |
◆ ConstRenderWindowPtr
| typedef shared_ptr<const RenderWindow> ConstRenderWindowPtr |
◆ ConstScenePtr
| typedef shared_ptr<const Scene> ConstScenePtr |
◆ ConstSensorPtr
| typedef shared_ptr<const Sensor> ConstSensorPtr |
◆ ConstSpotLightPtr
| typedef shared_ptr<const SpotLight> ConstSpotLightPtr |
◆ ConstSubMeshPtr
| typedef shared_ptr<const SubMesh> ConstSubMeshPtr |
◆ ConstVisualPtr
| typedef shared_ptr<const Visual> ConstVisualPtr |
◆ DirectionalLightPtr
◆ GeometryPtr
| typedef shared_ptr<Geometry> GeometryPtr |
◆ GeometryStore
| typedef Store<Geometry> GeometryStore |
◆ GeometryStorePtr
| typedef std::shared_ptr<GeometryStore> GeometryStorePtr |
◆ GridPtr
| typedef shared_ptr<Grid> GridPtr |
◆ ImagePtr
| typedef shared_ptr<Image> ImagePtr |
◆ JointVisualPtr
| typedef shared_ptr<JointVisual> JointVisualPtr |
◆ LightPtr
| typedef shared_ptr<Light> LightPtr |
◆ LightStore
| typedef Store<Light> LightStore |
◆ LightStorePtr
| typedef std::shared_ptr<LightStore> LightStorePtr |
◆ MaterialMap
| typedef Map<Material> MaterialMap |
◆ MaterialMapPtr
| typedef std::shared_ptr<MaterialMap> MaterialMapPtr |
◆ MaterialPtr
| typedef shared_ptr<Material> MaterialPtr |
◆ MeshPtr
| typedef shared_ptr<Mesh> MeshPtr |
◆ NodeCompositeStore
| typedef CompositeStore<Node> NodeCompositeStore |
◆ NodeCompositeStorePtr
◆ NodePtr
| typedef shared_ptr<Node> NodePtr |
◆ NodeStore
◆ NodeStorePtr
| typedef std::shared_ptr<NodeStore> NodeStorePtr |
◆ ObjectFactoryPtr
| typedef shared_ptr<ObjectFactory> ObjectFactoryPtr |
◆ ObjectPtr
| typedef shared_ptr<Object> ObjectPtr |
◆ OgreArrowVisualPtr
| typedef shared_ptr<OgreArrowVisual> OgreArrowVisualPtr |
◆ OgreAxisVisualPtr
| typedef shared_ptr<OgreAxisVisual> OgreAxisVisualPtr |
◆ OgreCameraPtr
| typedef shared_ptr<OgreCamera> OgreCameraPtr |
◆ OgreDirectionalLightPtr
◆ OgreGeometryPtr
| typedef shared_ptr<OgreGeometry> OgreGeometryPtr |
◆ OgreGeometryStore
| typedef BaseGeometryStore< OgreGeometry > OgreGeometryStore |
◆ OgreGeometryStorePtr
| typedef std::shared_ptr< OgreGeometryStore > OgreGeometryStorePtr |
◆ OgreGridPtr
| typedef shared_ptr<OgreGrid> OgreGridPtr |
◆ OgreJointVisualPtr
| typedef shared_ptr<OgreJointVisual> OgreJointVisualPtr |
◆ OgreLightPtr
| typedef shared_ptr<OgreLight> OgreLightPtr |
◆ OgreLightStore
| typedef BaseLightStore< OgreLight > OgreLightStore |
◆ OgreLightStorePtr
| typedef std::shared_ptr< OgreLightStore > OgreLightStorePtr |
◆ OgreMaterialMap
| typedef BaseMaterialMap< OgreMaterial > OgreMaterialMap |
◆ OgreMaterialMapPtr
| typedef std::shared_ptr< OgreMaterialMap > OgreMaterialMapPtr |
◆ OgreMaterialPtr
| typedef shared_ptr<OgreMaterial> OgreMaterialPtr |
◆ OgreMeshFactoryPtr
| typedef shared_ptr<OgreMeshFactory> OgreMeshFactoryPtr |
◆ OgreMeshPtr
| typedef shared_ptr<OgreMesh> OgreMeshPtr |
◆ OgreNodePtr
| typedef shared_ptr<OgreNode> OgreNodePtr |
◆ OgreNodeStore
| typedef BaseNodeStore< OgreNode > OgreNodeStore |
◆ OgreNodeStorePtr
| typedef std::shared_ptr< OgreNodeStore > OgreNodeStorePtr |
◆ OgreObjectPtr
| typedef shared_ptr<OgreObject> OgreObjectPtr |
◆ OgrePointLightPtr
| typedef shared_ptr<OgrePointLight> OgrePointLightPtr |
◆ OgreRayQueryPtr
| typedef shared_ptr<OgreRayQuery> OgreRayQueryPtr |
◆ OgreRenderEnginePtr
◆ OgreRenderTargetPtr
◆ OgreRenderTexturePtr
◆ OgreRenderWindowPtr
◆ OgreScenePtr
| typedef shared_ptr<OgreScene> OgreScenePtr |
◆ OgreSceneStore
| typedef BaseSceneStore< OgreScene > OgreSceneStore |
◆ OgreSceneStorePtr
| typedef std::shared_ptr< OgreSceneStore > OgreSceneStorePtr |
◆ OgreSensorPtr
| typedef shared_ptr<OgreSensor> OgreSensorPtr |
◆ OgreSensorStore
| typedef BaseSensorStore< OgreSensor > OgreSensorStore |
◆ OgreSensorStorePtr
| typedef std::shared_ptr< OgreSensorStore > OgreSensorStorePtr |
◆ OgreSpotLightPtr
| typedef shared_ptr<OgreSpotLight> OgreSpotLightPtr |
◆ OgreSubMeshPtr
| typedef shared_ptr<OgreSubMesh> OgreSubMeshPtr |
◆ OgreSubMeshStore
| typedef BaseSubMeshStore< OgreSubMesh > OgreSubMeshStore |
◆ OgreSubMeshStorePtr
| typedef std::shared_ptr< OgreSubMeshStore > OgreSubMeshStorePtr |
◆ OgreVisualPtr
| typedef shared_ptr<OgreVisual> OgreVisualPtr |
◆ OgreVisualStore
| typedef BaseVisualStore< OgreVisual > OgreVisualStore |
◆ OgreVisualStorePtr
| typedef std::shared_ptr< OgreVisualStore > OgreVisualStorePtr |
◆ PointLightPtr
| typedef shared_ptr<PointLight> PointLightPtr |
◆ RayQueryPtr
| typedef shared_ptr<RayQuery> RayQueryPtr |
◆ RenderTargetPtr
| typedef shared_ptr<RenderTarget> RenderTargetPtr |
◆ RenderTexturePtr
| typedef shared_ptr<RenderTexture> RenderTexturePtr |
◆ RenderWindowPtr
| typedef shared_ptr<RenderWindow> RenderWindowPtr |
◆ ScenePtr
| typedef shared_ptr<Scene> ScenePtr |
◆ SceneStore
| typedef Store<Scene> SceneStore |
◆ SceneStorePtr
| typedef std::shared_ptr<SceneStore> SceneStorePtr |
◆ SensorPtr
| typedef shared_ptr<Sensor> SensorPtr |
◆ SensorStore
| typedef Store<Sensor> SensorStore |
◆ SensorStorePtr
| typedef std::shared_ptr<SensorStore> SensorStorePtr |
◆ shared_ptr
| using shared_ptr = std::shared_ptr<T> |
◆ SpotLightPtr
| typedef shared_ptr<SpotLight> SpotLightPtr |
◆ SubMeshPtr
| typedef shared_ptr<SubMesh> SubMeshPtr |
◆ SubMeshStore
| typedef Store<SubMesh> SubMeshStore |
◆ SubMeshStorePtr
| typedef std::shared_ptr<SubMeshStore> SubMeshStorePtr |
◆ VisualPtr
| typedef shared_ptr<Visual> VisualPtr |
◆ VisualStore
| typedef Store<Visual> VisualStore |
◆ VisualStorePtr
| typedef std::shared_ptr<VisualStore> VisualStorePtr |
Enumeration Type Documentation
◆ PixelFormat
| enum PixelFormat |
◆ ShaderType
| enum ShaderType |
Available types of shaders. Note that not all rendering-engines will be able to use each type. They will instead default to the closest alternative.
ShaderType.hh ignition/rendering/ShaderType.hh
Function Documentation
◆ engine() [1/2]
| RenderEngine* ignition::rendering::engine | ( | const std::string & | _name | ) |
Get the render-engine registered under the given name. If no render-engine is registered under the given name, NULL will be returned.
- Parameters
-
[in] _name Name of the desired render-engine
- Returns
- The specified render-engine
◆ engine() [2/2]
| RenderEngine* ignition::rendering::engine | ( | const unsigned int | _index | ) |
Get the render-engine registered at the given index. If no render-engine is registered at the given index, NULL will be returned.
- Parameters
-
[in] _index Index of the desired render-engine
- Returns
- The specified render-engine
◆ engineCount()
| unsigned int ignition::rendering::engineCount | ( | ) |
Get the number of available render-engines.
- Returns
- The number of available render-engines
◆ fini()
| bool ignition::rendering::fini | ( | ) |
Destroy all render-engines and related resources.
- Returns
- True if successful
◆ hasEngine()
| bool ignition::rendering::hasEngine | ( | const std::string & | _name | ) |
Determine if a render-engine is registered under the given name.
- Parameters
-
[in] _name Name of the desired render-engine
- Returns
- True if a render-engine is registered under the given name
◆ init()
| bool ignition::rendering::init | ( | ) |
Initialized shared render-engine features.
- Returns
- True if successful
◆ registerEngine()
| void ignition::rendering::registerEngine | ( | const std::string & | _name, |
| RenderEngine * | _engine | ||
| ) |
Register a new render-engine under the given name. If the given name is already in use, the render-engine will not be registered.
- Parameters
-
[in] _name Name the render-engine will be registered under [in] _engine Render-engine to be registered
◆ unregisterEngine() [1/3]
| void ignition::rendering::unregisterEngine | ( | const std::string & | _name | ) |
Unregister a render-engine registered under the given name. If the no render-engine is registered under the given name no work will be done.
- Parameters
-
[in] _name Name of the render-engine to unregister
◆ unregisterEngine() [2/3]
| void ignition::rendering::unregisterEngine | ( | RenderEngine * | _engine | ) |
Unregister the given render-engine. If the given render-engine is not currently registered, no work will be done.
- Parameters
-
[in] _engine Render-engine to unregister
◆ unregisterEngine() [3/3]
| void ignition::rendering::unregisterEngine | ( | const unsigned int | _index | ) |
Unregister a render-engine at the given index. If the no render-engine is registered at the given index, no work will be done.
- Parameters
-
[in] _index Index of the render-engine to unregister