This class is the base class for all boxes. More...

Inheritance diagram for Ocean::Rendering::Box:

Public Member Functions
virtual Vector3	size () const
	Returns the dimensions of the box. More...

virtual bool	setSize (const Vector3 &size)
	Sets the dimensions of the box. More...

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

Public Member Functions inherited from Ocean::Rendering::Shape
ObjectType	type () const override
	Returns the type of this object. More...

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

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

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

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

ObjectRefs	parentObjects () const
	Returns all parent objects. More...

ObjectRefSet	parentNodes () const
	Returns all parent nodes. More...

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

Protected Member Functions
	Box ()
	Creates a new box object with default edge length (1, 1, 1) The box will be defined about the origin. More...

	~Box () override
	Destructs a box object. More...

Protected Member Functions inherited from Ocean::Rendering::Shape
	Shape ()
	Creates a new shape node. More...

	~Shape () override
	Destructs a shape node. More...

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

	~Renderable () override
	Destructs a renderable object. More...

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

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

virtual	~Object ()
	Destructs an object. More...

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

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

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

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

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

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

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

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

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

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

Detailed Description

This class is the base class for all boxes.

The box is defined about the origin with edge length (1, 1, 1).

Constructor & Destructor Documentation

◆ Box()

Ocean::Rendering::Box::Box ( )

protected

Creates a new box object with default edge length (1, 1, 1)
The box will be defined about the origin.

◆ ~Box()

Ocean::Rendering::Box::~Box ( )

overrideprotected

Destructs a box object.

Member Function Documentation

◆ setSize()

virtual bool Ocean::Rendering::Box::setSize ( const Vector3 & size )

virtual

Sets the dimensions of the box.

Parameters

size	Dimension of the box in x-, y-, and z-direction

Returns: True, if the specified size was valid and could be set

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GlobalIllumination::GIBox, and Ocean::Rendering::GLESceneGraph::GLESBox.

◆ size()

virtual Vector3 Ocean::Rendering::Box::size ( ) const

virtual

Returns the dimensions of the box.

Returns: Dimensions of the box

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GlobalIllumination::GIBox, and Ocean::Rendering::GLESceneGraph::GLESBox.

◆ type()

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

overridevirtual

Returns the type of this object.

See also: Object::type().

Reimplemented from Ocean::Rendering::Object.

Reimplemented in Ocean::Rendering::GlobalIllumination::GIBox, and Ocean::Rendering::GLESceneGraph::GLESBox.

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

rendering/Box.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Box()

◆ ~Box()

Member Function Documentation

◆ setSize()

◆ size()

◆ type()