Ocean
Loading...
Searching...
No Matches
Modules | Data Structures | Typedefs | Functions | Variables
Ocean Rendering Abstraction Library

The Ocean Rendering Library is the base library and organizer of all rendering libraries / plugins. More...

Collaboration diagram for Ocean Rendering Abstraction Library:

Modules

 Ocean Rendering GLESceneGraph Library
 The Ocean Rendering GLESceneGraph Library is a rendering library using OpenGL ES for rendering.
 
 Ocean Rendering Global Illumination Library
 The Ocean Rendering Global Illumination Library is a rendering library using Global Illumination.
 

Data Structures

class  Ocean::Rendering::AbsoluteTransform
 This class is the base class for all absolute transform nodes. More...
 
class  Ocean::Rendering::Attribute
 This class is the base class for all rendering attribute objects. More...
 
class  Ocean::Rendering::AttributeSet
 This class is the base class for all attribute set objects. More...
 
class  Ocean::Rendering::Background
 This class is the base class for all backgrounds. More...
 
class  Ocean::Rendering::Billboard
 This class is the base class for all billboard objects. More...
 
class  Ocean::Rendering::BitmapFramebuffer
 This class is the base class for all bitmap framebuffers. More...
 
class  Ocean::Rendering::BlendAttribute
 This class is the base class for all blend attributes. More...
 
class  Ocean::Rendering::Box
 This class is the base class for all boxes. More...
 
class  Ocean::Rendering::Cone
 This class is the base class for all cones. More...
 
class  Ocean::Rendering::Cylinder
 This class is the base class for all cylinders. More...
 
class  Ocean::Rendering::DepthAttribute
 This class implements a depth attribute specifying the depth buffer behavior for associated objects. More...
 
class  Ocean::Rendering::DirectionalLight
 This class is the base class for all directional lights. More...
 
class  Ocean::Rendering::DynamicObject
 This class is the base class for all dynamic scene graph objects. More...
 
class  Ocean::Rendering::Engine
 This class is the base class for all rendering engines like. More...
 
class  Ocean::Rendering::Factory
 This class implements a node and object factory. More...
 
class  Ocean::Rendering::Framebuffer
 This class is the base class for all rendering framebuffers. More...
 
class  Ocean::Rendering::FrameTexture2D
 This class is the base class for all 2D textures receiving their image content from a frame or a buffer. More...
 
class  Ocean::Rendering::Geometry
 This class is the base class for all rendering geometry nodes. More...
 
class  Ocean::Rendering::Group
 This is the base class for all rendering groups. More...
 
class  Ocean::Rendering::IndependentPrimitive
 This class is the base class for all independent primitive objects. More...
 
class  Ocean::Rendering::LightSource
 This is the base class for all lights. More...
 
class  Ocean::Rendering::Lines
 This class is the base for all lines objects. More...
 
class  Ocean::Rendering::LineStrips
 This class is the base for all rendering line strips. More...
 
class  Ocean::Rendering::LOD
 This class is the base class for all level-of-detail nodes. More...
 
class  Ocean::Rendering::Manager
 This class manages all scene graphs. More...
 
class  Ocean::Rendering::Material
 This class is the base class for all materials. More...
 
class  Ocean::Rendering::MediaTexture2D
 This class is the base class for all 2D textures receiving their image content from Media objects. More...
 
class  Ocean::Rendering::Node
 This is the base class for all rendering nodes. More...
 
class  Ocean::Rendering::Object
 This class is the base class for all rendering objects. More...
 
class  Ocean::Rendering::SmartObjectRef< T >
 This class implements a smart rendering object reference. More...
 
class  Ocean::Rendering::ObjectRefManager
 This class implements a rendering object reference manager. More...
 
class  Ocean::Rendering::ParallelView
 This class is the base class for all parallel views. More...
 
class  Ocean::Rendering::PerspectiveView
 This class is the base class for all perspective views. More...
 
class  Ocean::Rendering::PhantomAttribute
 This class is the base class for all phantom attributes. More...
 
class  Ocean::Rendering::PointLight
 This class is the base class for all point lights. More...
 
class  Ocean::Rendering::Points
 This class is the base for all points objects. More...
 
class  Ocean::Rendering::Primitive
 This class is the base class for all primitive objects. More...
 
class  Ocean::Rendering::PrimitiveAttribute
 This class implements an attribute specifying face and culling properties of primitives. More...
 
class  Ocean::Rendering::QuadFace
 Definition of a quad face with four vertex indices. More...
 
class  Ocean::Rendering::Quads
 This class is the base class for all rendering quads. More...
 
class  Ocean::Rendering::QuadStrips
 This class is the base class for all stripped quad objects. More...
 
class  Ocean::Rendering::Renderable
 This class is the base class for all renderable objects. More...
 
class  Ocean::Rendering::Scene
 This is the base class for all rendering scenes. More...
 
class  Ocean::Rendering::ShaderProgram
 This class implements a shader program attribute. More...
 
class  Ocean::Rendering::Shape
 This class is the base class for all geometries. More...
 
class  Ocean::Rendering::SkyBackground
 This class is the base class for all sky backgrounds. More...
 
class  Ocean::Rendering::Sphere
 This class is the base class for all spheres. More...
 
class  Ocean::Rendering::SpotLight
 This class is the base class for all spot lights. More...
 
class  Ocean::Rendering::StereoAttribute
 This class implements a stereo attribute specifying the stereo behavior for associated objects. More...
 
class  Ocean::Rendering::StereoView
 This class is the base class for all stereo views. More...
 
class  Ocean::Rendering::StripPrimitive
 This class is the base class for all primitive with strip organization. More...
 
class  Ocean::Rendering::Switch
 This class is the base class for all switch nodes. More...
 
class  Ocean::Rendering::Text
 This class is the base class for all texts. More...
 
class  Ocean::Rendering::Texture
 This class is the base class for all textures. More...
 
class  Ocean::Rendering::Texture2D
 This class is the base class for all 2D textures. More...
 
class  Ocean::Rendering::TextureFramebuffer
 This class is the base class for all textures based on a framebuffer. More...
 
class  Ocean::Rendering::Textures
 This class is the base class for all textures objects. More...
 
class  Ocean::Rendering::Transform
 This class is the base class for all transform nodes. More...
 
class  Ocean::Rendering::TriangleFace
 Definition of a triangle face with three vertex indices. More...
 
class  Ocean::Rendering::TriangleFans
 This class is the base class for all triangle fan objects. More...
 
class  Ocean::Rendering::Triangles
 This class is the base for all triangles objects. More...
 
class  Ocean::Rendering::TriangleStrips
 This class is the base for all rendering triangle strips. More...
 
class  Ocean::Rendering::UndistortedBackground
 This class is the base class for all undistorted backgrounds. More...
 
class  Ocean::Rendering::Utilities
 This class implements utility functions for the rendering library. More...
 
class  Ocean::Rendering::VertexSet
 This class is the base class for all rendering vertex sets. More...
 
class  Ocean::Rendering::View
 This class is the base class for all rendering views. More...
 
class  Ocean::Rendering::WindowFramebuffer
 This class is the base class for all window framebuffers. More...
 

Typedefs

using Ocean::Rendering::AbsoluteTransformRef = SmartObjectRef< AbsoluteTransform >
 Definition of a smart object reference holding a transform node.
 
using Ocean::Rendering::AttributeRef = SmartObjectRef< Attribute >
 Definition of a smart object reference holding an attribute.
 
using Ocean::Rendering::AttributeSetRef = SmartObjectRef< AttributeSet >
 Definition of a smart object reference holding an attribute set.
 
using Ocean::Rendering::BackgroundRef = SmartObjectRef< Background >
 Definition of a smart object reference holding a background.
 
using Ocean::Rendering::BillboardRef = SmartObjectRef< Billboard >
 Definition of a smart object reference holding a billboard.
 
using Ocean::Rendering::BitmapFramebufferRef = SmartObjectRef< BitmapFramebuffer >
 Definition of a smart object reference holding a bitmap framebuffer node.
 
using Ocean::Rendering::BlendAttributeRef = SmartObjectRef< BlendAttribute >
 Definition of a smart object reference holding a blend attribute.
 
using Ocean::Rendering::BoxRef = SmartObjectRef< Box >
 Definition of a smart object reference holding a box.
 
using Ocean::Rendering::ConeRef = SmartObjectRef< Cone >
 Definition of a smart object reference holding a cone.
 
using Ocean::Rendering::CylinderRef = SmartObjectRef< Cylinder >
 Definition of a smart object reference holding a cylinder.
 
using Ocean::Rendering::DepthAttributeRef = SmartObjectRef< DepthAttribute >
 Definition of a smart object reference holding a depth attribute.
 
using Ocean::Rendering::DirectionalLightRef = SmartObjectRef< DirectionalLight >
 Definition of a smart object reference holding a directional light.
 
using Ocean::Rendering::DynamicObjectRef = SmartObjectRef< DynamicObject >
 Definition of a smart object reference holding a dynamic object.
 
using Ocean::Rendering::EngineRef = Ocean::ObjectRef< Engine >
 Definition of an engine reference object.
 
using Ocean::Rendering::FramebufferRef = SmartObjectRef< Framebuffer >
 Definition of a smart object reference holding a framebuffer.
 
using Ocean::Rendering::FrameTexture2DRef = SmartObjectRef< FrameTexture2D >
 Definition of a smart object reference holding a 2D frame texture.
 
using Ocean::Rendering::GeometryRef = SmartObjectRef< Geometry >
 Definition of a smart object reference holding a geometry.
 
using Ocean::Rendering::GroupRef = SmartObjectRef< Group >
 Definition of a smart object reference holding a group.
 
using Ocean::Rendering::LightSourceRef = SmartObjectRef< LightSource >
 Definition of a smart object reference holding a light source object.
 
using Ocean::Rendering::LinesRef = SmartObjectRef< Lines >
 Definition of a smart object reference holding a lines node.
 
using Ocean::Rendering::LineStripsRef = SmartObjectRef< LineStrips >
 Definition of a smart object reference holding a line strips node.
 
using Ocean::Rendering::LODRef = SmartObjectRef< LOD >
 Definition of a smart object reference holding a LOD node.
 
using Ocean::Rendering::MaterialRef = SmartObjectRef< Material >
 Definition of a smart object reference holding a material.
 
using Ocean::Rendering::MediaTexture2DRef = SmartObjectRef< MediaTexture2D >
 Definition of a smart object reference holding a 2D texture.
 
using Ocean::Rendering::NodeRef = SmartObjectRef< Node >
 Definition of a smart object reference holding a node.
 
using Ocean::Rendering::NodeRefs = std::vector< NodeRef >
 Definition of a vector holding node references.
 
using Ocean::Rendering::ObjectRef = Ocean::ObjectRef< Object >
 Definition of a rendering object reference with an internal reference counter.
 
using Ocean::Rendering::ObjectRefs = std::vector< ObjectRef >
 Definition of a vector holding rendering object references.
 
using Ocean::Rendering::ObjectRefSet = std::set< ObjectRef >
 Definition of a vector holding rendering object references.
 
using Ocean::Rendering::ParallelViewRef = SmartObjectRef< ParallelView >
 Definition of a smart object reference holding a parallel view node.
 
using Ocean::Rendering::PerspectiveViewRef = SmartObjectRef< PerspectiveView >
 Definition of a smart object reference holding a perspective view node.
 
using Ocean::Rendering::PhantomAttributeRef = SmartObjectRef< PhantomAttribute >
 Definition of a smart object reference holding a phantom attribute.
 
using Ocean::Rendering::PointLightRef = SmartObjectRef< PointLight >
 Definition of a smart object reference holding a point light.
 
using Ocean::Rendering::PointsRef = SmartObjectRef< Points >
 Definition of a smart object reference holding a points node.
 
using Ocean::Rendering::PrimitiveRef = SmartObjectRef< Primitive >
 Definition of a smart object reference holding a primitive.
 
using Ocean::Rendering::PrimitiveAttributeRef = SmartObjectRef< PrimitiveAttribute >
 Definition of a smart object reference holding a primitive attribute.
 
using Ocean::Rendering::QuadFaces = std::vector< QuadFace >
 Definition of a vector holding quad faces.
 
using Ocean::Rendering::QuadsRef = SmartObjectRef< Quads >
 Definition of a smart object reference holding a quads object.
 
using Ocean::Rendering::QuadStripsRef = SmartObjectRef< QuadStrips >
 Definition of a smart object reference holding a quad strips object.
 
using Ocean::Rendering::RenderableRef = SmartObjectRef< Renderable >
 Definition of a smart object reference holding a renderable node.
 
using Ocean::Rendering::ObjectId = size_t
 Definition of a object id.
 
using Ocean::Rendering::VertexIndex = unsigned int
 Definition of a vertex index.
 
using Ocean::Rendering::Normal = Vector3
 Definition of a 3D normal.
 
using Ocean::Rendering::TextureCoordinate = Vector2
 Definition of a 2D texture coordinate.
 
using Ocean::Rendering::Vertex = Vector3
 Definition of a 3D vertex.
 
using Ocean::Rendering::VertexIndices = std::vector< VertexIndex >
 Definition of a vector holding vertex indices.
 
using Ocean::Rendering::Normals = std::vector< Normal >
 Definition of a vector holding normals.
 
using Ocean::Rendering::TextureCoordinates = std::vector< TextureCoordinate >
 Definition of a vector holding texture coordinates.
 
using Ocean::Rendering::Vertices = std::vector< Vertex >
 Definition of a vector holding vertices.
 
using Ocean::Rendering::VertexIndexGroups = std::vector< VertexIndices >
 Definition of a vector holding vertex indices.
 
using Ocean::Rendering::SceneRef = SmartObjectRef< Scene >
 Definition of a smart object reference holding a scene node.
 
using Ocean::Rendering::Scenes = std::vector< SceneRef >
 Definition of a vector holding scenes.
 
using Ocean::Rendering::ShaderProgramRef = SmartObjectRef< ShaderProgram >
 Definition of a smart object reference holding a shader program object.
 
using Ocean::Rendering::ShapeRef = SmartObjectRef< Shape >
 Definition of a smart object reference holding a shape.
 
using Ocean::Rendering::SkyBackgroundRef = SmartObjectRef< SkyBackground >
 Definition of a smart object reference holding a sky background.
 
using Ocean::Rendering::SphereRef = SmartObjectRef< Sphere >
 Definition of a smart object reference holding a sphere.
 
using Ocean::Rendering::SpotLightRef = SmartObjectRef< SpotLight >
 Definition of a smart object reference holding a spot light.
 
using Ocean::Rendering::StereoAttributeRef = SmartObjectRef< StereoAttribute >
 Definition of a smart object reference holding a stereo attribute.
 
using Ocean::Rendering::StereoViewRef = SmartObjectRef< StereoView >
 Definition of a smart object reference holding a stereo view node.
 
using Ocean::Rendering::StripPrimitiveRef = SmartObjectRef< StripPrimitive >
 Definition of a smart object reference holding a strip primitive.
 
using Ocean::Rendering::SwitchRef = SmartObjectRef< Switch >
 Definition of a smart object reference holding a switch.
 
using Ocean::Rendering::TextRef = SmartObjectRef< Text >
 Definition of a smart object reference holding a text.
 
using Ocean::Rendering::TextureRef = SmartObjectRef< Texture >
 Definition of a smart object reference holding a texture.
 
using Ocean::Rendering::Texture2DRef = SmartObjectRef< Texture2D >
 Definition of a smart object reference holding a 2D texture.
 
using Ocean::Rendering::TextureFramebufferRef = SmartObjectRef< TextureFramebuffer >
 Definition of a smart object reference holding a texture framebuffer.
 
using Ocean::Rendering::TexturesRef = SmartObjectRef< Textures >
 Definition of a smart object reference holding a textures.
 
using Ocean::Rendering::TransformRef = SmartObjectRef< Transform >
 Definition of a smart object reference holding a transform node.
 
using Ocean::Rendering::TransformRefs = std::vector< TransformRef >
 Definition of a vector of references holding transform nods.
 
using Ocean::Rendering::TriangleFaces = std::vector< TriangleFace >
 Definition of a vector holding triangle faces.
 
using Ocean::Rendering::TriangleFansRef = SmartObjectRef< TriangleFans >
 Definition of a smart object reference holding a triangle fans node.
 
using Ocean::Rendering::TrianglesRef = SmartObjectRef< Triangles >
 Definition of a smart object reference holding a triangles node.
 
using Ocean::Rendering::TriangleStripsRef = SmartObjectRef< TriangleStrips >
 Definition of a smart object reference holding a triangle strips node.
 
using Ocean::Rendering::UndistortedBackgroundRef = SmartObjectRef< UndistortedBackground >
 Definition of a smart object reference holding an undistorted background node.
 
using Ocean::Rendering::VertexSetRef = SmartObjectRef< VertexSet >
 Definition of a smart object reference holding a vertex set node.
 
using Ocean::Rendering::ViewRef = SmartObjectRef< View >
 Definition of a smart object reference holding a view node.
 
using Ocean::Rendering::WindowFramebufferRef = SmartObjectRef< WindowFramebuffer >
 Definition of a smart object reference holding a window framebuffer node.
 

Functions

std::ostream & Ocean::Rendering::operator<< (std::ostream &stream, const Object &object)
 Write the descriptive information of an object to a stream.
 
template<bool tActive>
MessageObject< tActive > & Ocean::Rendering::operator<< (MessageObject< tActive > &messageObject, const Object &object)
 Write the descriptive information of an object to a message object.
 
template<bool tActive>
MessageObject< tActive > & Ocean::Rendering::operator<< (MessageObject< tActive > &&messageObject, const Object &object)
 Write the descriptive information of an object to a message object.
 

Variables

const ObjectId Ocean::Rendering::invalidObjectId = ObjectId(-1)
 Definition of an invalid object id.
 
constexpr VertexIndex Ocean::Rendering::invalidIndex = VertexIndex(-1)
 Definition of an invalid vertex index.
 

Detailed Description

The Ocean Rendering Library is the base library and organizer of all rendering libraries / plugins.


In major, this library holds abstract objects only and therefore is used as an interface to provide access to different rendering plugins.
Each rendering plugin provides a framebuffer as well as a scenegraph.

Two different framebuffers can be chosen: a standard window framebuffer or a bitmap framebuffer.
The scenegraph provides standard scenegraph elements like e.g. nodes, groups, transform nodes, geometry nodes, shapes, materials and textures.
Derived rendering libraries use this abstract base library to implement rendering plugins with e.g. different 3rdparty frameworks.
Use the manager to get access to a specific rendering plugin.
Beware: Never use the specific rendering plugin directly.
Using the abstract rendering objects guarantees that different rendering plugins can be used by the same code.

Each engine provides an object factory to create object and nodes necessary for scene graph building.
Implemented (not abstract) rendering plugins are e.g. GLESceneGraph rendering plugins.

However, a rendering plugin is allowed to implement a subset of the entire functionality only.
Therefore, not supported functions will throw an exception.
The library is platform independent.

See also
Manager, Engine, Factory, Framebuffer, Object, Node, NotSupportedException.

Typedef Documentation

◆ AbsoluteTransformRef

using Ocean::Rendering::AbsoluteTransformRef = typedef SmartObjectRef<AbsoluteTransform>

Definition of a smart object reference holding a transform node.

See also
SmartObjectRef, AbsoluteTransform.

◆ AttributeRef

using Ocean::Rendering::AttributeRef = typedef SmartObjectRef<Attribute>

Definition of a smart object reference holding an attribute.

See also
SmartObjectRef, Attribute.

◆ AttributeSetRef

using Ocean::Rendering::AttributeSetRef = typedef SmartObjectRef<AttributeSet>

Definition of a smart object reference holding an attribute set.

See also
SmartObjectRef, AttributeSet.

◆ BackgroundRef

using Ocean::Rendering::BackgroundRef = typedef SmartObjectRef<Background>

Definition of a smart object reference holding a background.

See also
SmartObjectRef, Background.

◆ BillboardRef

using Ocean::Rendering::BillboardRef = typedef SmartObjectRef<Billboard>

Definition of a smart object reference holding a billboard.

See also
SmartObjectRef, Billboard.

◆ BitmapFramebufferRef

using Ocean::Rendering::BitmapFramebufferRef = typedef SmartObjectRef<BitmapFramebuffer>

Definition of a smart object reference holding a bitmap framebuffer node.

See also
SmartObjectRef, BitmapFramebuffer.

◆ BlendAttributeRef

using Ocean::Rendering::BlendAttributeRef = typedef SmartObjectRef<BlendAttribute>

Definition of a smart object reference holding a blend attribute.

See also
SmartObjectRef, BlendAttribute.

◆ BoxRef

using Ocean::Rendering::BoxRef = typedef SmartObjectRef<Box>

Definition of a smart object reference holding a box.

See also
SmartObjectRef, Box.

◆ ConeRef

using Ocean::Rendering::ConeRef = typedef SmartObjectRef<Cone>

Definition of a smart object reference holding a cone.

See also
SmartObjectRef, Cone.

◆ CylinderRef

using Ocean::Rendering::CylinderRef = typedef SmartObjectRef<Cylinder>

Definition of a smart object reference holding a cylinder.

See also
SmartObjectRef, Cylinder.

◆ DepthAttributeRef

using Ocean::Rendering::DepthAttributeRef = typedef SmartObjectRef<DepthAttribute>

Definition of a smart object reference holding a depth attribute.

See also
SmartObjectRef, DepthAttribute.

◆ DirectionalLightRef

using Ocean::Rendering::DirectionalLightRef = typedef SmartObjectRef<DirectionalLight>

Definition of a smart object reference holding a directional light.

See also
SmartObjectRef, DirectionalLight.

◆ DynamicObjectRef

using Ocean::Rendering::DynamicObjectRef = typedef SmartObjectRef<DynamicObject>

Definition of a smart object reference holding a dynamic object.

See also
SmartObjectRef, DynamicObject.

◆ EngineRef

using Ocean::Rendering::EngineRef = typedef Ocean::ObjectRef<Engine>

Definition of an engine reference object.

◆ FramebufferRef

using Ocean::Rendering::FramebufferRef = typedef SmartObjectRef<Framebuffer>

Definition of a smart object reference holding a framebuffer.

See also
SmartObjectRef, Framebuffer.

◆ FrameTexture2DRef

using Ocean::Rendering::FrameTexture2DRef = typedef SmartObjectRef<FrameTexture2D>

Definition of a smart object reference holding a 2D frame texture.

See also
SmartObjectRef, Texture2D.

◆ GeometryRef

using Ocean::Rendering::GeometryRef = typedef SmartObjectRef<Geometry>

Definition of a smart object reference holding a geometry.

See also
SmartObjectRef, Geometry.

◆ GroupRef

using Ocean::Rendering::GroupRef = typedef SmartObjectRef<Group>

Definition of a smart object reference holding a group.

See also
SmartObjectRef, Group.

◆ LightSourceRef

using Ocean::Rendering::LightSourceRef = typedef SmartObjectRef<LightSource>

Definition of a smart object reference holding a light source object.

See also
SmartObjectRef, LightSource.

◆ LinesRef

using Ocean::Rendering::LinesRef = typedef SmartObjectRef<Lines>

Definition of a smart object reference holding a lines node.

See also
SmartObjectRef, Lines.

◆ LineStripsRef

using Ocean::Rendering::LineStripsRef = typedef SmartObjectRef<LineStrips>

Definition of a smart object reference holding a line strips node.

See also
SmartObjectRef, LineStrips.

◆ LODRef

using Ocean::Rendering::LODRef = typedef SmartObjectRef<LOD>

Definition of a smart object reference holding a LOD node.

See also
SmartObjectRef, LOD.

◆ MaterialRef

using Ocean::Rendering::MaterialRef = typedef SmartObjectRef<Material>

Definition of a smart object reference holding a material.

See also
SmartObjectRef, Material.

◆ MediaTexture2DRef

using Ocean::Rendering::MediaTexture2DRef = typedef SmartObjectRef<MediaTexture2D>

Definition of a smart object reference holding a 2D texture.

See also
SmartObjectRef, Texture2D.

◆ NodeRef

using Ocean::Rendering::NodeRef = typedef SmartObjectRef<Node>

Definition of a smart object reference holding a node.

See also
SmartObjectRef, Node.

◆ NodeRefs

using Ocean::Rendering::NodeRefs = typedef std::vector<NodeRef>

Definition of a vector holding node references.

◆ Normal

using Ocean::Rendering::Normal = typedef Vector3

Definition of a 3D normal.

◆ Normals

using Ocean::Rendering::Normals = typedef std::vector<Normal>

Definition of a vector holding normals.

◆ ObjectId

using Ocean::Rendering::ObjectId = typedef size_t

Definition of a object id.

◆ ObjectRef

using Ocean::Rendering::ObjectRef = typedef Ocean::ObjectRef<Object>

Definition of a rendering object reference with an internal reference counter.

See also
Object.

◆ ObjectRefs

using Ocean::Rendering::ObjectRefs = typedef std::vector<ObjectRef>

Definition of a vector holding rendering object references.

◆ ObjectRefSet

using Ocean::Rendering::ObjectRefSet = typedef std::set<ObjectRef>

Definition of a vector holding rendering object references.

◆ ParallelViewRef

using Ocean::Rendering::ParallelViewRef = typedef SmartObjectRef<ParallelView>

Definition of a smart object reference holding a parallel view node.

See also
SmartObjectRef, ParallelView.

◆ PerspectiveViewRef

using Ocean::Rendering::PerspectiveViewRef = typedef SmartObjectRef<PerspectiveView>

Definition of a smart object reference holding a perspective view node.

See also
SmartObjectRef, PerspectiveView.

◆ PhantomAttributeRef

using Ocean::Rendering::PhantomAttributeRef = typedef SmartObjectRef<PhantomAttribute>

Definition of a smart object reference holding a phantom attribute.

See also
SmartObjectRef, PhantomAttribute.

◆ PointLightRef

using Ocean::Rendering::PointLightRef = typedef SmartObjectRef<PointLight>

Definition of a smart object reference holding a point light.

See also
SmartObjectRef, PointLight.

◆ PointsRef

using Ocean::Rendering::PointsRef = typedef SmartObjectRef<Points>

Definition of a smart object reference holding a points node.

See also
SmartObjectRef, Points.

◆ PrimitiveAttributeRef

using Ocean::Rendering::PrimitiveAttributeRef = typedef SmartObjectRef<PrimitiveAttribute>

Definition of a smart object reference holding a primitive attribute.

See also
SmartObjectRef, PrimitiveAttribute.

◆ PrimitiveRef

using Ocean::Rendering::PrimitiveRef = typedef SmartObjectRef<Primitive>

Definition of a smart object reference holding a primitive.

See also
SmartObjectRef, Primitive.

◆ QuadFaces

using Ocean::Rendering::QuadFaces = typedef std::vector<QuadFace>

Definition of a vector holding quad faces.

◆ QuadsRef

using Ocean::Rendering::QuadsRef = typedef SmartObjectRef<Quads>

Definition of a smart object reference holding a quads object.

See also
SmartObjectRef, Quads.

◆ QuadStripsRef

using Ocean::Rendering::QuadStripsRef = typedef SmartObjectRef<QuadStrips>

Definition of a smart object reference holding a quad strips object.

See also
SmartObjectRef, QuadStrips.

◆ RenderableRef

using Ocean::Rendering::RenderableRef = typedef SmartObjectRef<Renderable>

Definition of a smart object reference holding a renderable node.

See also
SmartObjectRef, Renderable.

◆ SceneRef

using Ocean::Rendering::SceneRef = typedef SmartObjectRef<Scene>

Definition of a smart object reference holding a scene node.

See also
SmartObjectRef, Scene.

◆ Scenes

using Ocean::Rendering::Scenes = typedef std::vector<SceneRef>

Definition of a vector holding scenes.

◆ ShaderProgramRef

using Ocean::Rendering::ShaderProgramRef = typedef SmartObjectRef<ShaderProgram>

Definition of a smart object reference holding a shader program object.

See also
SmartObjectRef, ShaderProgram.

◆ ShapeRef

using Ocean::Rendering::ShapeRef = typedef SmartObjectRef<Shape>

Definition of a smart object reference holding a shape.

See also
SmartObjectRef, Shape.

◆ SkyBackgroundRef

using Ocean::Rendering::SkyBackgroundRef = typedef SmartObjectRef<SkyBackground>

Definition of a smart object reference holding a sky background.

See also
SmartObjectRef, SkyBackground.

◆ SphereRef

using Ocean::Rendering::SphereRef = typedef SmartObjectRef<Sphere>

Definition of a smart object reference holding a sphere.

See also
SmartObjectRef, Sphere.

◆ SpotLightRef

using Ocean::Rendering::SpotLightRef = typedef SmartObjectRef<SpotLight>

Definition of a smart object reference holding a spot light.

See also
SmartObjectRef, SpotLight.

◆ StereoAttributeRef

using Ocean::Rendering::StereoAttributeRef = typedef SmartObjectRef<StereoAttribute>

Definition of a smart object reference holding a stereo attribute.

See also
SmartObjectRef, StereoAttribute.

◆ StereoViewRef

using Ocean::Rendering::StereoViewRef = typedef SmartObjectRef<StereoView>

Definition of a smart object reference holding a stereo view node.

See also
SmartObjectRef, StereoView.

◆ StripPrimitiveRef

using Ocean::Rendering::StripPrimitiveRef = typedef SmartObjectRef<StripPrimitive>

Definition of a smart object reference holding a strip primitive.

See also
SmartObjectRef, StripPrimitive.

◆ SwitchRef

using Ocean::Rendering::SwitchRef = typedef SmartObjectRef<Switch>

Definition of a smart object reference holding a switch.

See also
SmartObjectRef, Switch.

◆ TextRef

using Ocean::Rendering::TextRef = typedef SmartObjectRef<Text>

Definition of a smart object reference holding a text.

See also
SmartObjectRef, Text.

◆ Texture2DRef

using Ocean::Rendering::Texture2DRef = typedef SmartObjectRef<Texture2D>

Definition of a smart object reference holding a 2D texture.

See also
SmartObjectRef, Texture2D.

◆ TextureCoordinate

using Ocean::Rendering::TextureCoordinate = typedef Vector2

Definition of a 2D texture coordinate.

◆ TextureCoordinates

using Ocean::Rendering::TextureCoordinates = typedef std::vector<TextureCoordinate>

Definition of a vector holding texture coordinates.

◆ TextureFramebufferRef

using Ocean::Rendering::TextureFramebufferRef = typedef SmartObjectRef<TextureFramebuffer>

Definition of a smart object reference holding a texture framebuffer.

See also
SmartObjectRef, TextureFramebuffer.

◆ TextureRef

using Ocean::Rendering::TextureRef = typedef SmartObjectRef<Texture>

Definition of a smart object reference holding a texture.

See also
SmartObjectRef, Texture.

◆ TexturesRef

using Ocean::Rendering::TexturesRef = typedef SmartObjectRef<Textures>

Definition of a smart object reference holding a textures.

See also
SmartObjectRef, Textures.

◆ TransformRef

using Ocean::Rendering::TransformRef = typedef SmartObjectRef<Transform>

Definition of a smart object reference holding a transform node.

See also
SmartObjectRef, Transform.

◆ TransformRefs

using Ocean::Rendering::TransformRefs = typedef std::vector<TransformRef>

Definition of a vector of references holding transform nods.

◆ TriangleFaces

using Ocean::Rendering::TriangleFaces = typedef std::vector<TriangleFace>

Definition of a vector holding triangle faces.

See also
TriangleFace.

◆ TriangleFansRef

using Ocean::Rendering::TriangleFansRef = typedef SmartObjectRef<TriangleFans>

Definition of a smart object reference holding a triangle fans node.

See also
SmartObjectRef, TriangleFans.

◆ TrianglesRef

using Ocean::Rendering::TrianglesRef = typedef SmartObjectRef<Triangles>

Definition of a smart object reference holding a triangles node.

See also
SmartObjectRef, Triangles.

◆ TriangleStripsRef

using Ocean::Rendering::TriangleStripsRef = typedef SmartObjectRef<TriangleStrips>

Definition of a smart object reference holding a triangle strips node.

See also
SmartObjectRef, TriangleStrips.

◆ UndistortedBackgroundRef

using Ocean::Rendering::UndistortedBackgroundRef = typedef SmartObjectRef<UndistortedBackground>

Definition of a smart object reference holding an undistorted background node.

See also
SmartObjectRef, UndistortedBackground.

◆ Vertex

using Ocean::Rendering::Vertex = typedef Vector3

Definition of a 3D vertex.

◆ VertexIndex

using Ocean::Rendering::VertexIndex = typedef unsigned int

Definition of a vertex index.

◆ VertexIndexGroups

using Ocean::Rendering::VertexIndexGroups = typedef std::vector<VertexIndices>

Definition of a vector holding vertex indices.

◆ VertexIndices

using Ocean::Rendering::VertexIndices = typedef std::vector<VertexIndex>

Definition of a vector holding vertex indices.

◆ VertexSetRef

using Ocean::Rendering::VertexSetRef = typedef SmartObjectRef<VertexSet>

Definition of a smart object reference holding a vertex set node.

See also
SmartObjectRef, VertexSet.

◆ Vertices

using Ocean::Rendering::Vertices = typedef std::vector<Vertex>

Definition of a vector holding vertices.

◆ ViewRef

using Ocean::Rendering::ViewRef = typedef SmartObjectRef<View>

Definition of a smart object reference holding a view node.

A view can holds several background objects, however only the first one is used for rendering.

See also
SmartObjectRef, View.

◆ WindowFramebufferRef

using Ocean::Rendering::WindowFramebufferRef = typedef SmartObjectRef<WindowFramebuffer>

Definition of a smart object reference holding a window framebuffer node.

See also
SmartObjectRef, WindowFramebuffer.

Function Documentation

◆ operator<<() [1/3]

template<bool tActive>
MessageObject< tActive > & Ocean::Rendering::operator<< ( MessageObject< tActive > &&  messageObject,
const Object &  object 
)
inline

Write the descriptive information of an object to a message object.

Parameters
messageObjectThe message object to which the object's description will be written
objectThe object to be written to the message object
Template Parameters
tActiveTrue, if the messenger object is active; False, if the messenger object is disabled

◆ operator<<() [2/3]

template<bool tActive>
MessageObject< tActive > & Ocean::Rendering::operator<< ( MessageObject< tActive > &  messageObject,
const Object &  object 
)
inline

Write the descriptive information of an object to a message object.

Parameters
messageObjectThe message object to which the object's description will be written
objectThe object to be written to the message object
Template Parameters
tActiveTrue, if the messenger object is active; False, if the messenger object is disabled

◆ operator<<() [3/3]

std::ostream & Ocean::Rendering::operator<< ( std::ostream &  stream,
const Object &  object 
)
inline

Write the descriptive information of an object to a stream.

Parameters
streamThe stream to which the object's description will be written
objectThe object to be written to the stream

Variable Documentation

◆ invalidIndex

constexpr VertexIndex Ocean::Rendering::invalidIndex = VertexIndex(-1)
constexpr

Definition of an invalid vertex index.

◆ invalidObjectId

const ObjectId Ocean::Rendering::invalidObjectId = ObjectId(-1)

Definition of an invalid object id.