This class implements a node and object factory. More...

#include <Factory.h>

Inheritance diagram for Ocean::Rendering::Factory:

Public Member Functions
virtual	~Factory ()
	Destructor.

virtual ObjectRef	createAbsoluteTransform () const
	Creates a new absolute transform.

virtual ObjectRef	createAttributeSet () const
	Creates a new attribute set object.

virtual NodeRef	createBillboard () const
	Creates a new billboard object.

virtual ObjectRef	createBlendAttribute () const
	Creates a new blend attribute object.

virtual ObjectRef	createBox () const
	Creates a new box object.

virtual ObjectRef	createCone () const
	Creates a new cone object.

virtual ObjectRef	createCylinder () const
	Creates a new cylinder object.

virtual ObjectRef	createDepthAttribute () const
	Creates a new depth attribute object.

virtual ObjectRef	createDirectionalLight () const
	Creates a new directional light object.

virtual ObjectRef	createFrameTexture2D () const
	Creates a new frame texture object.

virtual NodeRef	createGeometry () const
	Creates a new geometry object.

virtual NodeRef	createGroup () const
	Creates a new group object.

virtual ObjectRef	createLines () const
	Creates a new lines object.

virtual ObjectRef	createLineStrips () const
	Creates a new line strips object.

virtual NodeRef	createLOD () const
	Creates a new LOD object.

virtual ObjectRef	createMaterial () const
	Creates a new material object.

virtual ObjectRef	createMediaTexture2D () const
	Creates a new media texture object.

virtual ObjectRef	createParallelView () const
	Creates a new parallel view object.

virtual ObjectRef	createPerspectiveView () const
	Creates a new perspective view object.

virtual ObjectRef	createPhantomAttribute () const
	Creates a new phantom attribute object.

virtual ObjectRef	createPointLight () const
	Creates a new point light object.

virtual ObjectRef	createPoints () const
	Creates a new points object.

virtual ObjectRef	createPrimitiveAttribute () const
	Creates a new primitive attribute object.

virtual ObjectRef	createQuads () const
	Creates a new quads object.

virtual ObjectRef	createQuadStrips () const
	Creates a new quad strips object.

virtual NodeRef	createScene () const
	Creates a new scene object.

virtual ObjectRef	createShaderProgram () const
	Creates a new shader program object.

virtual NodeRef	createSkyBackground () const
	Creates a new sky background object.

virtual ObjectRef	createSphere () const
	Creates a new sphere object.

virtual ObjectRef	createSpotLight () const
	Creates a new spot light object.

virtual ObjectRef	createStereoAttribute () const
	Creates a new stereo attribute object.

virtual ObjectRef	createStereoView () const
	Creates a new stereo view object.

virtual NodeRef	createSwitch () const
	Creates a new switch object.

virtual ObjectRef	createText () const
	Creates a new text object.

virtual ObjectRef	createTextureFramebuffer () const
	Creates a new texture framebuffer object.

virtual ObjectRef	createTextures () const
	Creates a new texture attribute object.

virtual NodeRef	createTransform () const
	Creates a new transform object.

virtual ObjectRef	createTriangles () const
	Creates a new triangles object.

virtual ObjectRef	createTriangleFans () const
	Creates a new triangle fans object.

virtual ObjectRef	createTriangleStrips () const
	Creates a new triangle strips object.

virtual NodeRef	createUndistortedBackground () const
	Creates a new undistorted background node.

virtual ObjectRef	createVertexSet () const
	Creates a new vertex set object.

virtual ObjectRef	createObject (const std::string &type) const
	Creates a new object specified by the object type name.

Protected Member Functions
	Factory ()
	Protected default constructor creating a new Factory.

	Factory (const Factory &factory)=delete
	Disabled copy constructor.

ObjectRef	createReference (Object *object) const
	Creates a new object reference by a given object.

Factory &	operator= (const Factory &factory)=delete
	Disabled copy operator.

Detailed Description

This class implements a node and object factory.

A factory instance can be received from the associated engine instance.
However, there is no guarantee that all objects are supported for a specific render engine.
Therefore, all factory functions will throw an exception if the selected object is not supported.

See also: Engine, NotSupportedException

Constructor & Destructor Documentation

◆ ~Factory()

Ocean::Rendering::Factory::~Factory ( )

inlinevirtual

Destructor.

◆ Factory() [1/2]

Ocean::Rendering::Factory::Factory ( )

protected

Protected default constructor creating a new Factory.

◆ Factory() [2/2]

Ocean::Rendering::Factory::Factory ( const Factory & factory )

protecteddelete

Disabled copy constructor.

Parameters

factory Object which would be copied

Member Function Documentation

◆ createAbsoluteTransform()

virtual ObjectRef Ocean::Rendering::Factory::createAbsoluteTransform ( ) const

virtual

Creates a new absolute transform.

Returns: New absolute transform

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createAttributeSet()

virtual ObjectRef Ocean::Rendering::Factory::createAttributeSet ( ) const

virtual

Creates a new attribute set object.

Returns: New attribute set

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createBillboard()

virtual NodeRef Ocean::Rendering::Factory::createBillboard ( ) const

virtual

Creates a new billboard object.

Returns: New billboard

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createBlendAttribute()

virtual ObjectRef Ocean::Rendering::Factory::createBlendAttribute ( ) const

virtual

Creates a new blend attribute object.

Returns: New blend attribute

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createBox()

virtual ObjectRef Ocean::Rendering::Factory::createBox ( ) const

virtual

Creates a new box object.

Returns: New box

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createCone()

virtual ObjectRef Ocean::Rendering::Factory::createCone ( ) const

virtual

Creates a new cone object.

Returns: New cone

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createCylinder()

virtual ObjectRef Ocean::Rendering::Factory::createCylinder ( ) const

virtual

Creates a new cylinder object.

Returns: New cylinder

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createDepthAttribute()

virtual ObjectRef Ocean::Rendering::Factory::createDepthAttribute ( ) const

virtual

Creates a new depth attribute object.

Returns: New depth attribute

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createDirectionalLight()

virtual ObjectRef Ocean::Rendering::Factory::createDirectionalLight ( ) const

virtual

Creates a new directional light object.

Returns: New directional light

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createFrameTexture2D()

virtual ObjectRef Ocean::Rendering::Factory::createFrameTexture2D ( ) const

virtual

Creates a new frame texture object.

Returns: New texture

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory.

◆ createGeometry()

virtual NodeRef Ocean::Rendering::Factory::createGeometry ( ) const

virtual

Creates a new geometry object.

Returns: New geometry

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createGroup()

virtual NodeRef Ocean::Rendering::Factory::createGroup ( ) const

virtual

Creates a new group object.

Returns: New group

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createLines()

virtual ObjectRef Ocean::Rendering::Factory::createLines ( ) const

virtual

Creates a new lines object.

Returns: New lines

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory.

◆ createLineStrips()

virtual ObjectRef Ocean::Rendering::Factory::createLineStrips ( ) const

virtual

Creates a new line strips object.

Returns: New line strips

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory.

◆ createLOD()

virtual NodeRef Ocean::Rendering::Factory::createLOD ( ) const

virtual

Creates a new LOD object.

Returns: new LOD

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createMaterial()

virtual ObjectRef Ocean::Rendering::Factory::createMaterial ( ) const

virtual

Creates a new material object.

Returns: New material

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createMediaTexture2D()

virtual ObjectRef Ocean::Rendering::Factory::createMediaTexture2D ( ) const

virtual

Creates a new media texture object.

Returns: New texture

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createObject()

virtual ObjectRef Ocean::Rendering::Factory::createObject ( const std::string & type ) const

virtual

Creates a new object specified by the object type name.

This function may be overloaded if a rendering plugin supports more than the standard objects.

Parameters

type	The type of the object to be created, must be valid

Returns: New rendering object if available, otherwise an empty object reference

Exceptions

NotSupportedException Is thrown if this function is not supported

◆ createParallelView()

virtual ObjectRef Ocean::Rendering::Factory::createParallelView ( ) const

virtual

Creates a new parallel view object.

Returns: New parallel view

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createPerspectiveView()

virtual ObjectRef Ocean::Rendering::Factory::createPerspectiveView ( ) const

virtual

Creates a new perspective view object.

Returns: New perspective view

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createPhantomAttribute()

virtual ObjectRef Ocean::Rendering::Factory::createPhantomAttribute ( ) const

virtual

Creates a new phantom attribute object.

Returns: New phantom attribute

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createPointLight()

virtual ObjectRef Ocean::Rendering::Factory::createPointLight ( ) const

virtual

Creates a new point light object.

Returns: New light

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createPoints()

virtual ObjectRef Ocean::Rendering::Factory::createPoints ( ) const

virtual

Creates a new points object.

Returns: New points

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createPrimitiveAttribute()

virtual ObjectRef Ocean::Rendering::Factory::createPrimitiveAttribute ( ) const

virtual

Creates a new primitive attribute object.

Returns: New attribute

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createQuads()

virtual ObjectRef Ocean::Rendering::Factory::createQuads ( ) const

virtual

Creates a new quads object.

Returns: New quads

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createQuadStrips()

virtual ObjectRef Ocean::Rendering::Factory::createQuadStrips ( ) const

virtual

Creates a new quad strips object.

Returns: New quad strips

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createReference()

ObjectRef Ocean::Rendering::Factory::createReference ( Object * object ) const

inlineprotected

Creates a new object reference by a given object.

Parameters

object The object to create a object reference from, must be valid

Returns: Created object reference

◆ createScene()

virtual NodeRef Ocean::Rendering::Factory::createScene ( ) const

virtual

Creates a new scene object.

Returns: New scene

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createShaderProgram()

virtual ObjectRef Ocean::Rendering::Factory::createShaderProgram ( ) const

virtual

Creates a new shader program object.

Returns: New shader program

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createSkyBackground()

virtual NodeRef Ocean::Rendering::Factory::createSkyBackground ( ) const

virtual

Creates a new sky background object.

Returns: New sky background

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createSphere()

virtual ObjectRef Ocean::Rendering::Factory::createSphere ( ) const

virtual

Creates a new sphere object.

Returns: New sphere

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createSpotLight()

virtual ObjectRef Ocean::Rendering::Factory::createSpotLight ( ) const

virtual

Creates a new spot light object.

Returns: New spot light

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createStereoAttribute()

virtual ObjectRef Ocean::Rendering::Factory::createStereoAttribute ( ) const

virtual

Creates a new stereo attribute object.

Returns: New stereo attribute

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory.

◆ createStereoView()

virtual ObjectRef Ocean::Rendering::Factory::createStereoView ( ) const

virtual

Creates a new stereo view object.

Returns: New stereo view

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createSwitch()

virtual NodeRef Ocean::Rendering::Factory::createSwitch ( ) const

virtual

Creates a new switch object.

Returns: New switch

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createText()

virtual ObjectRef Ocean::Rendering::Factory::createText ( ) const

virtual

Creates a new text object.

Returns: The new text framebuffer object

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory.

◆ createTextureFramebuffer()

virtual ObjectRef Ocean::Rendering::Factory::createTextureFramebuffer ( ) const

virtual

Creates a new texture framebuffer object.

Returns: The new texture framebuffer object

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory.

◆ createTextures()

virtual ObjectRef Ocean::Rendering::Factory::createTextures ( ) const

virtual

Creates a new texture attribute object.

Returns: New texture attribute

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createTransform()

virtual NodeRef Ocean::Rendering::Factory::createTransform ( ) const

virtual

Creates a new transform object.

Returns: New transform

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createTriangleFans()

virtual ObjectRef Ocean::Rendering::Factory::createTriangleFans ( ) const

virtual

Creates a new triangle fans object.

Returns: New triangle fans

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createTriangles()

virtual ObjectRef Ocean::Rendering::Factory::createTriangles ( ) const

virtual

Creates a new triangles object.

Returns: New triangles

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createTriangleStrips()

virtual ObjectRef Ocean::Rendering::Factory::createTriangleStrips ( ) const

virtual

Creates a new triangle strips object.

Returns: New triangle strips

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createUndistortedBackground()

virtual NodeRef Ocean::Rendering::Factory::createUndistortedBackground ( ) const

virtual

Creates a new undistorted background node.

Returns: New undistorted background

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ createVertexSet()

virtual ObjectRef Ocean::Rendering::Factory::createVertexSet ( ) const

virtual

Creates a new vertex set object.

Returns: New vertex set

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESFactory, and Ocean::Rendering::GlobalIllumination::GIFactory.

◆ operator=()

Factory & Ocean::Rendering::Factory::operator= ( const Factory & factory )

protecteddelete

Disabled copy operator.

Parameters

factory Object which would be copied

Returns: Reference to this object

The documentation for this class was generated from the following file:

rendering/Factory.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~Factory()

◆ Factory() [1/2]

◆ Factory() [2/2]

Member Function Documentation

◆ createAbsoluteTransform()

◆ createAttributeSet()

◆ createBillboard()

◆ createBlendAttribute()

◆ createBox()

◆ createCone()

◆ createCylinder()

◆ createDepthAttribute()

◆ createDirectionalLight()

◆ createFrameTexture2D()

◆ createGeometry()

◆ createGroup()

◆ createLines()

◆ createLineStrips()

◆ createLOD()

◆ createMaterial()

◆ createMediaTexture2D()

◆ createObject()

◆ createParallelView()

◆ createPerspectiveView()

◆ createPhantomAttribute()

◆ createPointLight()

◆ createPoints()

◆ createPrimitiveAttribute()

◆ createQuads()

◆ createQuadStrips()

◆ createReference()

◆ createScene()

◆ createShaderProgram()

◆ createSkyBackground()

◆ createSphere()

◆ createSpotLight()

◆ createStereoAttribute()

◆ createStereoView()

◆ createSwitch()

◆ createText()

◆ createTextureFramebuffer()

◆ createTextures()

◆ createTransform()

◆ createTriangleFans()

◆ createTriangles()

◆ createTriangleStrips()

◆ createUndistortedBackground()

◆ createVertexSet()

◆ operator=()