This class is the base class for all phantom attributes. More...

#include <PhantomAttribute.h>

Inheritance diagram for Ocean::Rendering::PhantomAttribute:

Public Types
enum	PhantomMode { PM_INVALID , PM_DEFAULT , PM_COLOR , PM_DEBUG , PM_VIDEO }
	Definition of different phantom modes. More...

enum	ExtendedPhantomMode { EPM_INVALID = 0 , EPM_VIDEO = PM_VIDEO , EPM_VIDEO_FAST , EPM_VIDEO_TEXTURE_COORDINATES , EPM_VIDEO_FAST_TEXTURE_COORDINATES }
	Definition of extenced phantom modes. More...

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.

Public Member Functions
ObjectType	type () const override
	Returns the type of this 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
	PhantomAttribute ()
	Creates a new phantom attribute.

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

	~Attribute () override
	Destructs an attribute 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.

Protected Attributes
unsigned int	attributePhantomMode
	Attribute phantom mode.

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

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

Detailed Description

This class is the base class for all phantom attributes.

See also: Attribute

Member Enumeration Documentation

◆ ExtendedPhantomMode

enum Ocean::Rendering::PhantomAttribute::ExtendedPhantomMode

Definition of extenced phantom modes.

TODO Merge this enum with enum PhantomMode

Enumerator
EPM_INVALID	Invalid mode.
EPM_VIDEO
EPM_VIDEO_FAST	The fast phantom video mode.
EPM_VIDEO_TEXTURE_COORDINATES	The default phantom video mode with explicit texture coordinates.
EPM_VIDEO_FAST_TEXTURE_COORDINATES	The fast phantom video mode with explicit texture coordinates.

◆ PhantomMode

enum Ocean::Rendering::PhantomAttribute::PhantomMode

Definition of different phantom modes.

Enumerator
PM_INVALID	Invalid phantom mode.
PM_DEFAULT	Default phantom mode.
PM_COLOR	Background color phantom mode.
PM_DEBUG	Debug phantom mode.
PM_VIDEO	Background view phantom mode.

Constructor & Destructor Documentation

◆ PhantomAttribute()

Ocean::Rendering::PhantomAttribute::PhantomAttribute ( )

protected

Creates a new phantom attribute.

Member Function Documentation

◆ type()

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

overridevirtual

Returns the type of this object.

See also: Object::type().

Reimplemented from Ocean::Rendering::Attribute.

Field Documentation

◆ attributePhantomMode

unsigned int Ocean::Rendering::PhantomAttribute::attributePhantomMode

protected

Attribute phantom mode.

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

PhantomAttribute.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members