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
typedef SmartObjectRef< AbsoluteTransform >	Ocean::Rendering::AbsoluteTransformRef
	Definition of a smart object reference holding a transform node. More...

typedef SmartObjectRef< Attribute >	Ocean::Rendering::AttributeRef
	Definition of a smart object reference holding an attribute. More...

typedef SmartObjectRef< AttributeSet >	Ocean::Rendering::AttributeSetRef
	Definition of a smart object reference holding an attribute set. More...

typedef SmartObjectRef< Background >	Ocean::Rendering::BackgroundRef
	Definition of a smart object reference holding a background. More...

typedef SmartObjectRef< Billboard >	Ocean::Rendering::BillboardRef
	Definition of a smart object reference holding a billboard. More...

typedef SmartObjectRef< BitmapFramebuffer >	Ocean::Rendering::BitmapFramebufferRef
	Definition of a smart object reference holding a bitmap framebuffer node. More...

typedef SmartObjectRef< BlendAttribute >	Ocean::Rendering::BlendAttributeRef
	Definition of a smart object reference holding a blend attribute. More...

typedef SmartObjectRef< Box >	Ocean::Rendering::BoxRef
	Definition of a smart object reference holding a box. More...

typedef SmartObjectRef< Cone >	Ocean::Rendering::ConeRef
	Definition of a smart object reference holding a cone. More...

typedef SmartObjectRef< Cylinder >	Ocean::Rendering::CylinderRef
	Definition of a smart object reference holding a cylinder. More...

typedef SmartObjectRef< DepthAttribute >	Ocean::Rendering::DepthAttributeRef
	Definition of a smart object reference holding a depth attribute. More...

typedef SmartObjectRef< DirectionalLight >	Ocean::Rendering::DirectionalLightRef
	Definition of a smart object reference holding a directional light. More...

typedef SmartObjectRef< DynamicObject >	Ocean::Rendering::DynamicObjectRef
	Definition of a smart object reference holding a dynamic object. More...

typedef Ocean::ObjectRef< Engine >	Ocean::Rendering::EngineRef
	Definition of an engine reference object. More...

typedef SmartObjectRef< Framebuffer >	Ocean::Rendering::FramebufferRef
	Definition of a smart object reference holding a framebuffer. More...

typedef SmartObjectRef< FrameTexture2D >	Ocean::Rendering::FrameTexture2DRef
	Definition of a smart object reference holding a 2D frame texture. More...

typedef SmartObjectRef< Geometry >	Ocean::Rendering::GeometryRef
	Definition of a smart object reference holding a geometry. More...

typedef SmartObjectRef< Group >	Ocean::Rendering::GroupRef
	Definition of a smart object reference holding a group. More...

typedef SmartObjectRef< LightSource >	Ocean::Rendering::LightSourceRef
	Definition of a smart object reference holding a light source object. More...

typedef SmartObjectRef< Lines >	Ocean::Rendering::LinesRef
	Definition of a smart object reference holding a lines node. More...

typedef SmartObjectRef< LineStrips >	Ocean::Rendering::LineStripsRef
	Definition of a smart object reference holding a line strips node. More...

typedef SmartObjectRef< LOD >	Ocean::Rendering::LODRef
	Definition of a smart object reference holding a LOD node. More...

typedef SmartObjectRef< Material >	Ocean::Rendering::MaterialRef
	Definition of a smart object reference holding a material. More...

typedef SmartObjectRef< MediaTexture2D >	Ocean::Rendering::MediaTexture2DRef
	Definition of a smart object reference holding a 2D texture. More...

typedef SmartObjectRef< Node >	Ocean::Rendering::NodeRef
	Definition of a smart object reference holding a node. More...

typedef std::vector< NodeRef >	Ocean::Rendering::NodeRefs
	Definition of a vector holding node references. More...

typedef Ocean::ObjectRef< Object >	Ocean::Rendering::ObjectRef
	Definition of a rendering object reference with an internal reference counter. More...

typedef std::vector< ObjectRef >	Ocean::Rendering::ObjectRefs
	Definition of a vector holding rendering object references. More...

typedef std::set< ObjectRef >	Ocean::Rendering::ObjectRefSet
	Definition of a vector holding rendering object references. More...

typedef SmartObjectRef< ParallelView >	Ocean::Rendering::ParallelViewRef
	Definition of a smart object reference holding a parallel view node. More...

typedef SmartObjectRef< PerspectiveView >	Ocean::Rendering::PerspectiveViewRef
	Definition of a smart object reference holding a perspective view node. More...

typedef SmartObjectRef< PhantomAttribute >	Ocean::Rendering::PhantomAttributeRef
	Definition of a smart object reference holding a phantom attribute. More...

typedef SmartObjectRef< PointLight >	Ocean::Rendering::PointLightRef
	Definition of a smart object reference holding a point light. More...

typedef SmartObjectRef< Points >	Ocean::Rendering::PointsRef
	Definition of a smart object reference holding a points node. More...

typedef SmartObjectRef< Primitive >	Ocean::Rendering::PrimitiveRef
	Definition of a smart object reference holding a primitive. More...

typedef SmartObjectRef< PrimitiveAttribute >	Ocean::Rendering::PrimitiveAttributeRef
	Definition of a smart object reference holding a primitive attribute. More...

typedef std::vector< QuadFace >	Ocean::Rendering::QuadFaces
	Definition of a vector holding quad faces. More...

typedef SmartObjectRef< Quads >	Ocean::Rendering::QuadsRef
	Definition of a smart object reference holding a quads object. More...

typedef SmartObjectRef< QuadStrips >	Ocean::Rendering::QuadStripsRef
	Definition of a smart object reference holding a quad strips object. More...

typedef SmartObjectRef< Renderable >	Ocean::Rendering::RenderableRef
	Definition of a smart object reference holding a renderable node. More...

typedef size_t	Ocean::Rendering::ObjectId
	Definition of a object id. More...

typedef unsigned int	Ocean::Rendering::VertexIndex
	Definition of a vertex index. More...

typedef Vector3	Ocean::Rendering::Normal
	Definition of a 3D normal. More...

typedef Vector2	Ocean::Rendering::TextureCoordinate
	Definition of a 2D texture coordinate. More...

typedef Vector3	Ocean::Rendering::Vertex
	Definition of a 3D vertex. More...

typedef std::vector< VertexIndex >	Ocean::Rendering::VertexIndices
	Definition of a vector holding vertex indices. More...

typedef std::vector< Normal >	Ocean::Rendering::Normals
	Definition of a vector holding normals. More...

typedef std::vector< TextureCoordinate >	Ocean::Rendering::TextureCoordinates
	Definition of a vector holding texture coordinates. More...

typedef std::vector< Vertex >	Ocean::Rendering::Vertices
	Definition of a vector holding vertices. More...

typedef std::vector< VertexIndices >	Ocean::Rendering::VertexIndexGroups
	Definition of a vector holding vertex indices. More...

typedef SmartObjectRef< Scene >	Ocean::Rendering::SceneRef
	Definition of a smart object reference holding a scene node. More...

typedef std::vector< SceneRef >	Ocean::Rendering::Scenes
	Definition of a vector holding scenes. More...

typedef SmartObjectRef< ShaderProgram >	Ocean::Rendering::ShaderProgramRef
	Definition of a smart object reference holding a shader program object. More...

typedef SmartObjectRef< Shape >	Ocean::Rendering::ShapeRef
	Definition of a smart object reference holding a shape. More...

typedef SmartObjectRef< SkyBackground >	Ocean::Rendering::SkyBackgroundRef
	Definition of a smart object reference holding a sky background. More...

typedef SmartObjectRef< Sphere >	Ocean::Rendering::SphereRef
	Definition of a smart object reference holding a sphere. More...

typedef SmartObjectRef< SpotLight >	Ocean::Rendering::SpotLightRef
	Definition of a smart object reference holding a spot light. More...

typedef SmartObjectRef< StereoAttribute >	Ocean::Rendering::StereoAttributeRef
	Definition of a smart object reference holding a stereo attribute. More...

typedef SmartObjectRef< StereoView >	Ocean::Rendering::StereoViewRef
	Definition of a smart object reference holding a stereo view node. More...

typedef SmartObjectRef< StripPrimitive >	Ocean::Rendering::StripPrimitiveRef
	Definition of a smart object reference holding a strip primitive. More...

typedef SmartObjectRef< Switch >	Ocean::Rendering::SwitchRef
	Definition of a smart object reference holding a switch. More...

typedef SmartObjectRef< Text >	Ocean::Rendering::TextRef
	Definition of a smart object reference holding a text. More...

typedef SmartObjectRef< Texture >	Ocean::Rendering::TextureRef
	Definition of a smart object reference holding a texture. More...

typedef SmartObjectRef< Texture2D >	Ocean::Rendering::Texture2DRef
	Definition of a smart object reference holding a 2D texture. More...

typedef SmartObjectRef< TextureFramebuffer >	Ocean::Rendering::TextureFramebufferRef
	Definition of a smart object reference holding a texture framebuffer. More...

typedef SmartObjectRef< Textures >	Ocean::Rendering::TexturesRef
	Definition of a smart object reference holding a textures. More...

typedef SmartObjectRef< Transform >	Ocean::Rendering::TransformRef
	Definition of a smart object reference holding a transform node. More...

typedef std::vector< TransformRef >	Ocean::Rendering::TransformRefs
	Definition of a vector of references holding transform nods. More...

typedef std::vector< TriangleFace >	Ocean::Rendering::TriangleFaces
	Definition of a vector holding triangle faces. More...

typedef SmartObjectRef< TriangleFans >	Ocean::Rendering::TriangleFansRef
	Definition of a smart object reference holding a triangle fans node. More...

typedef SmartObjectRef< Triangles >	Ocean::Rendering::TrianglesRef
	Definition of a smart object reference holding a triangles node. More...

typedef SmartObjectRef< TriangleStrips >	Ocean::Rendering::TriangleStripsRef
	Definition of a smart object reference holding a triangle strips node. More...

typedef SmartObjectRef< UndistortedBackground >	Ocean::Rendering::UndistortedBackgroundRef
	Definition of a smart object reference holding an undistorted background node. More...

typedef SmartObjectRef< VertexSet >	Ocean::Rendering::VertexSetRef
	Definition of a smart object reference holding a vertex set node. More...

typedef SmartObjectRef< View >	Ocean::Rendering::ViewRef
	Definition of a smart object reference holding a view node. More...

typedef SmartObjectRef< WindowFramebuffer >	Ocean::Rendering::WindowFramebufferRef
	Definition of a smart object reference holding a window framebuffer node. More...

Functions
std::ostream &	Ocean::Rendering::operator<< (std::ostream &stream, const Object &object)
	Write the descriptive information of an object to a stream. More...

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

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

Variables
const ObjectId	Ocean::Rendering::invalidObjectId = ObjectId(-1)
	Definition of an invalid object id. More...

constexpr VertexIndex	Ocean::Rendering::invalidIndex = VertexIndex(-1)
	Definition of an invalid vertex index. More...

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. the NvidiaSceniX or GLESceneGraph rendering pludings.

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

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

Definition of a smart object reference holding a transform node.

See also: SmartObjectRef, AbsoluteTransform.

◆ AttributeRef

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

Definition of a smart object reference holding an attribute.

See also: SmartObjectRef, Attribute.

◆ AttributeSetRef

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

Definition of a smart object reference holding an attribute set.

See also: SmartObjectRef, AttributeSet.

◆ BackgroundRef

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

Definition of a smart object reference holding a background.

See also: SmartObjectRef, Background.

◆ BillboardRef

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

Definition of a smart object reference holding a billboard.

See also: SmartObjectRef, Billboard.

◆ BitmapFramebufferRef

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

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

See also: SmartObjectRef, BitmapFramebuffer.

◆ BlendAttributeRef

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

Definition of a smart object reference holding a blend attribute.

See also: SmartObjectRef, BlendAttribute.

◆ BoxRef

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

Definition of a smart object reference holding a box.

See also: SmartObjectRef, Box.

◆ ConeRef

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

Definition of a smart object reference holding a cone.

See also: SmartObjectRef, Cone.

◆ CylinderRef

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

Definition of a smart object reference holding a cylinder.

See also: SmartObjectRef, Cylinder.

◆ DepthAttributeRef

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

Definition of a smart object reference holding a depth attribute.

See also: SmartObjectRef, DepthAttribute.

◆ DirectionalLightRef

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

Definition of a smart object reference holding a directional light.

See also: SmartObjectRef, DirectionalLight.

◆ DynamicObjectRef

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

Definition of a smart object reference holding a dynamic object.

See also: SmartObjectRef, DynamicObject.

◆ EngineRef

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

Definition of an engine reference object.

◆ FramebufferRef

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

Definition of a smart object reference holding a framebuffer.

See also: SmartObjectRef, Framebuffer.

◆ FrameTexture2DRef

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

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

See also: SmartObjectRef, Texture2D.

◆ GeometryRef

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

Definition of a smart object reference holding a geometry.

See also: SmartObjectRef, Geometry.

◆ GroupRef

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

Definition of a smart object reference holding a group.

See also: SmartObjectRef, Group.

◆ LightSourceRef

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

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

See also: SmartObjectRef, LightSource.

◆ LinesRef

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

Definition of a smart object reference holding a lines node.

See also: SmartObjectRef, Lines.

◆ LineStripsRef

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

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

See also: SmartObjectRef, LineStrips.

◆ LODRef

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

Definition of a smart object reference holding a LOD node.

See also: SmartObjectRef, LOD.

◆ MaterialRef

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

Definition of a smart object reference holding a material.

See also: SmartObjectRef, Material.

◆ MediaTexture2DRef

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

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

See also: SmartObjectRef, Texture2D.

◆ NodeRef

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

Definition of a smart object reference holding a node.

See also: SmartObjectRef, Node.

◆ NodeRefs

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

Definition of a vector holding node references.

◆ Normal

typedef Vector3 Ocean::Rendering::Normal

Definition of a 3D normal.

◆ Normals

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

Definition of a vector holding normals.

◆ ObjectId

typedef size_t Ocean::Rendering::ObjectId

Definition of a object id.

◆ ObjectRef

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

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

See also: Object.

◆ ObjectRefs

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

Definition of a vector holding rendering object references.

◆ ObjectRefSet

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

Definition of a vector holding rendering object references.

◆ ParallelViewRef

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

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

See also: SmartObjectRef, ParallelView.

◆ PerspectiveViewRef

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

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

See also: SmartObjectRef, PerspectiveView.

◆ PhantomAttributeRef

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

Definition of a smart object reference holding a phantom attribute.

See also: SmartObjectRef, PhantomAttribute.

◆ PointLightRef

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

Definition of a smart object reference holding a point light.

See also: SmartObjectRef, PointLight.

◆ PointsRef

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

Definition of a smart object reference holding a points node.

See also: SmartObjectRef, Points.

◆ PrimitiveAttributeRef

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

Definition of a smart object reference holding a primitive attribute.

See also: SmartObjectRef, PrimitiveAttribute.

◆ PrimitiveRef

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

Definition of a smart object reference holding a primitive.

See also: SmartObjectRef, Primitive.

◆ QuadFaces

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

Definition of a vector holding quad faces.

◆ QuadsRef

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

Definition of a smart object reference holding a quads object.

See also: SmartObjectRef, Quads.

◆ QuadStripsRef

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

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

See also: SmartObjectRef, QuadStrips.

◆ RenderableRef

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

Definition of a smart object reference holding a renderable node.

See also: SmartObjectRef, Renderable.

◆ SceneRef

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

Definition of a smart object reference holding a scene node.

See also: SmartObjectRef, Scene.

◆ Scenes

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

Definition of a vector holding scenes.

◆ ShaderProgramRef

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

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

See also: SmartObjectRef, ShaderProgram.

◆ ShapeRef

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

Definition of a smart object reference holding a shape.

See also: SmartObjectRef, Shape.

◆ SkyBackgroundRef

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

Definition of a smart object reference holding a sky background.

See also: SmartObjectRef, SkyBackground.

◆ SphereRef

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

Definition of a smart object reference holding a sphere.

See also: SmartObjectRef, Sphere.

◆ SpotLightRef

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

Definition of a smart object reference holding a spot light.

See also: SmartObjectRef, SpotLight.

◆ StereoAttributeRef

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

Definition of a smart object reference holding a stereo attribute.

See also: SmartObjectRef, StereoAttribute.

◆ StereoViewRef

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

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

See also: SmartObjectRef, StereoView.

◆ StripPrimitiveRef

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

Definition of a smart object reference holding a strip primitive.

See also: SmartObjectRef, StripPrimitive.

◆ SwitchRef

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

Definition of a smart object reference holding a switch.

See also: SmartObjectRef, Switch.

◆ TextRef

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

Definition of a smart object reference holding a text.

See also: SmartObjectRef, Text.

◆ Texture2DRef

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

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

See also: SmartObjectRef, Texture2D.

◆ TextureCoordinate

typedef Vector2 Ocean::Rendering::TextureCoordinate

Definition of a 2D texture coordinate.

◆ TextureCoordinates

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

Definition of a vector holding texture coordinates.

◆ TextureFramebufferRef

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

Definition of a smart object reference holding a texture framebuffer.

See also: SmartObjectRef, TextureFramebuffer.

◆ TextureRef

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

Definition of a smart object reference holding a texture.

See also: SmartObjectRef, Texture.

◆ TexturesRef

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

Definition of a smart object reference holding a textures.

See also: SmartObjectRef, Textures.

◆ TransformRef

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

Definition of a smart object reference holding a transform node.

See also: SmartObjectRef, Transform.

◆ TransformRefs

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

Definition of a vector of references holding transform nods.

◆ TriangleFaces

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

Definition of a vector holding triangle faces.

See also: TriangleFace.

◆ TriangleFansRef

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

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

See also: SmartObjectRef, TriangleFans.

◆ TrianglesRef

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

Definition of a smart object reference holding a triangles node.

See also: SmartObjectRef, Triangles.

◆ TriangleStripsRef

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

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

See also: SmartObjectRef, TriangleStrips.

◆ UndistortedBackgroundRef

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

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

See also: SmartObjectRef, UndistortedBackground.

◆ Vertex

typedef Vector3 Ocean::Rendering::Vertex

Definition of a 3D vertex.

◆ VertexIndex

typedef unsigned int Ocean::Rendering::VertexIndex

Definition of a vertex index.

◆ VertexIndexGroups

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

Definition of a vector holding vertex indices.

◆ VertexIndices

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

Definition of a vector holding vertex indices.

◆ VertexSetRef

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

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

See also: SmartObjectRef, VertexSet.

◆ Vertices

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

Definition of a vector holding vertices.

◆ ViewRef

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

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

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

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

messageObject	The message object to which the object's description will be written
object	The object to be written to the message object

Template Parameters

tActive True, 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

messageObject	The message object to which the object's description will be written
object	The object to be written to the message object

Template Parameters

tActive True, 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

stream	The stream to which the object's description will be written
object	The 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.

Modules

Data Structures

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ AbsoluteTransformRef

◆ AttributeRef

◆ AttributeSetRef

◆ BackgroundRef

◆ BillboardRef

◆ BitmapFramebufferRef

◆ BlendAttributeRef

◆ BoxRef

◆ ConeRef

◆ CylinderRef

◆ DepthAttributeRef

◆ DirectionalLightRef

◆ DynamicObjectRef

◆ EngineRef

◆ FramebufferRef

◆ FrameTexture2DRef

◆ GeometryRef

◆ GroupRef

◆ LightSourceRef

◆ LinesRef

◆ LineStripsRef

◆ LODRef

◆ MaterialRef

◆ MediaTexture2DRef

◆ NodeRef

◆ NodeRefs

◆ Normal

◆ Normals

◆ ObjectId

◆ ObjectRef

◆ ObjectRefs

◆ ObjectRefSet

◆ ParallelViewRef

◆ PerspectiveViewRef

◆ PhantomAttributeRef

◆ PointLightRef

◆ PointsRef

◆ PrimitiveAttributeRef

◆ PrimitiveRef

◆ QuadFaces

◆ QuadsRef

◆ QuadStripsRef

◆ RenderableRef

◆ SceneRef

◆ Scenes

◆ ShaderProgramRef

◆ ShapeRef

◆ SkyBackgroundRef

◆ SphereRef

◆ SpotLightRef

◆ StereoAttributeRef

◆ StereoViewRef

◆ StripPrimitiveRef

◆ SwitchRef

◆ TextRef

◆ Texture2DRef

◆ TextureCoordinate

◆ TextureCoordinates

◆ TextureFramebufferRef

◆ TextureRef

◆ TexturesRef

◆ TransformRef

◆ TransformRefs

◆ TriangleFaces

◆ TriangleFansRef

◆ TrianglesRef

◆ TriangleStripsRef

◆ UndistortedBackgroundRef

◆ Vertex

◆ VertexIndex

◆ VertexIndexGroups

◆ VertexIndices

◆ VertexSetRef