This class is the base class for all primitive with strip organization. More...

#include <StripPrimitive.h>

Inheritance diagram for Ocean::Rendering::StripPrimitive:

Public Member Functions
virtual VertexIndexGroups	strips () const
	Returns the strips of this primitive object.

virtual unsigned int	numberStrips () const
	Returns the number of triangle strips defined in this primitive.

virtual void	setStrips (const VertexIndexGroups &strips)
	Sets the strips of this primitive object.

ObjectType	type () const override
	Returns the type of this object.

Public Member Functions inherited from Ocean::Rendering::Primitive
const VertexSetRef &	vertexSet () const
	Returns the vertex set of this primitive object.

virtual void	setVertexSet (const VertexSetRef &vertexSet)
	Sets the vertex set of this primitive object.

Public Member Functions inherited from Ocean::Rendering::Object
ObjectId	id () const
	Returns the unique object id of this object.

const std::string &	name () const
	Returns the name of this object.

virtual void	setName (const std::string &name)
	Sets or changes the name of this object.

virtual const std::string &	engineName () const =0
	Returns the name of the owner engine.

ObjectRefs	parentObjects () const
	Returns all parent objects.

ObjectRefSet	parentNodes () const
	Returns all parent nodes.

virtual std::string	descriptiveInformation () const
	Returns descriptive information about the object as string.

Protected Member Functions
	StripPrimitive ()
	Creates a new strip primitive object.

	~StripPrimitive () override
	Destructs a strip primitive object.

Protected Member Functions inherited from Ocean::Rendering::Primitive
	Primitive ()
	Creates a new primitive object.

	~Primitive () override
	Destructs a primitive object.

Protected Member Functions inherited from Ocean::Rendering::Renderable
	Renderable ()
	Creates a new renderable object.

	~Renderable () override
	Destructs a renderable object.

Protected Member Functions inherited from Ocean::Rendering::Object
	Object ()
	Creates a new object.

	Object (const Object &object)=delete
	Disabled copy constructor.

virtual	~Object ()
	Destructs an object.

Engine &	engine () const
	Returns the render engine which is owner of this object.

void	registerParent (const ObjectId parentId)
	Registers a parent node for this (child) node.

void	unregisterParent (const ObjectId parentId)
	Unregisters a parent node for this (child) node.

void	registerThisObjectAsParent (const ObjectRef &child)
	Registers this object at a child as parent object.

void	unregisterThisObjectAsParent (const ObjectRef &child)
	Unregisters this object from a child as parent.

Object &	operator= (const Object &object)=delete
	Disabled copy operator.

Additional Inherited Members
Public Types inherited from Ocean::Rendering::Object
enum	ObjectType { TYPE_UNKNOWN , TYPE_ABSOLUTE_TRANSFORM , TYPE_ATTRIBUTE , TYPE_ATTRIBUTE_SET , TYPE_BACKGROUND , TYPE_BILLBOARD , TYPE_BITMAP_FRAMEBUFFER , TYPE_BLEND_ATTRIBUTE , TYPE_BOX , TYPE_CONE , TYPE_CYLINDER , TYPE_DEPTH_ATTRIBUTE , TYPE_DIRECTIONAL_LIGHT , TYPE_FRAMEBUFFER , TYPE_FRAME_TEXTURE_2D , TYPE_GEOMETRY , TYPE_GROUP , TYPE_INDEPENDENT_PRIMITIVE , TYPE_LIGHT_SOURCE , TYPE_LINES , TYPE_LINE_STRIPS , TYPE_LOD , TYPE_MATERIAL , TYPE_NODE , TYPE_OBJECT , TYPE_PARALLEL_VIEW , TYPE_PERSPECTIVE_VIEW , TYPE_PHANTOM_ATTRIBUTE , TYPE_POINT_LIGHT , TYPE_POINTS , TYPE_PRIMITIVE , TYPE_PRIMITIVE_ATTRIBUTE , TYPE_QUAD_STRIPS , TYPE_QUADS , TYPE_RENDERABLE , TYPE_SCENE , TYPE_SHADER_PROGRAM , TYPE_SHAPE , TYPE_SKY_BACKGROUND , TYPE_SPHERE , TYPE_SPOT_LIGHT , TYPE_STEREO_ATTRIBUTE , TYPE_STEREO_VIEW , TYPE_STRIP_PRIMITIVE , TYPE_SWITCH , TYPE_TEXT , TYPE_TEXTURE , TYPE_TEXTURE_2D , TYPE_MEDIA_TEXTURE_2D , TYPE_TEXTURE_FRAMEBUFFER , TYPE_TEXTURES , TYPE_TRANSFORM , TYPE_TRIANGLE_FANS , TYPE_TRIANGLES , TYPE_TRIANGLE_STRIPS , TYPE_UNDISTORTED_BACKGROUND , TYPE_VERTEX_SET , TYPE_VIEW , TYPE_WINDOW_FRAMEBUFFER }
	Definition of different object type. More...

using	ObjectIdMap = std::unordered_map< ObjectId, unsigned int >
	Definition of a map holding object ids to reference counters.

Static Public Member Functions inherited from Ocean::Rendering::Object
static std::string	translateObjectType (const ObjectType objectType)
	Translates an object type to a readable string.

Protected Attributes inherited from Ocean::Rendering::Primitive
VertexSetRef	primitiveVertexSet
	Vertex set object.

Protected Attributes inherited from Ocean::Rendering::Object
Lock	objectLock
	Lock for the object.

Detailed Description

This class is the base class for all primitive with strip organization.

Constructor & Destructor Documentation

◆ StripPrimitive()

Ocean::Rendering::StripPrimitive::StripPrimitive ( )

protected

Creates a new strip primitive object.

◆ ~StripPrimitive()

Ocean::Rendering::StripPrimitive::~StripPrimitive ( )

overrideprotected

Destructs a strip primitive object.

Member Function Documentation

◆ numberStrips()

virtual unsigned int Ocean::Rendering::StripPrimitive::numberStrips ( ) const

virtual

Returns the number of triangle strips defined in this primitive.

Returns: Number of triangle strips

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESLineStrips, Ocean::Rendering::GLESceneGraph::GLESTriangleFans, Ocean::Rendering::GLESceneGraph::GLESTriangleStrips, and Ocean::Rendering::GlobalIllumination::GITriangleStrips.

◆ setStrips()

virtual void Ocean::Rendering::StripPrimitive::setStrips ( const VertexIndexGroups & strips )

virtual

Sets the strips of this primitive object.

Parameters

strips The strips to set

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESLineStrips, Ocean::Rendering::GLESceneGraph::GLESTriangleFans, Ocean::Rendering::GLESceneGraph::GLESTriangleStrips, and Ocean::Rendering::GlobalIllumination::GITriangleStrips.

◆ strips()

virtual VertexIndexGroups Ocean::Rendering::StripPrimitive::strips ( ) const

virtual

Returns the strips of this primitive object.

Returns: Strips of primitive

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESLineStrips, Ocean::Rendering::GLESceneGraph::GLESStripPrimitive, Ocean::Rendering::GLESceneGraph::GLESTriangleFans, Ocean::Rendering::GLESceneGraph::GLESTriangleStrips, and Ocean::Rendering::GlobalIllumination::GIStripPrimitive.

◆ type()

ObjectType Ocean::Rendering::StripPrimitive::type ( ) const

overridevirtual

Returns the type of this object.

See also: Object::type().

Reimplemented from Ocean::Rendering::Primitive.

Reimplemented in Ocean::Rendering::TriangleFans, and Ocean::Rendering::TriangleStrips.

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

StripPrimitive.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StripPrimitive()

◆ ~StripPrimitive()

Member Function Documentation

◆ numberStrips()

◆ setStrips()

◆ strips()

◆ type()