Ocean
Ocean::Rendering::Cylinder Class Reference

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

Inheritance diagram for Ocean::Rendering::Cylinder:

Public Member Functions

virtual Scalar height () const
 Returns the height of this cylinder. More...
 
virtual Scalar radius () const
 Returns the radius of this cylinder. More...
 
virtual bool top () const
 Returns whether the top face of the cylinder is visible. More...
 
virtual bool bottom () const
 Returns whether the bottom face of the cylinder is visible. More...
 
virtual bool side () const
 Reutrn whether the side face of the cylinder is visible. More...
 
virtual bool setHeight (const Scalar height)
 Sets the height of this cylinder. More...
 
virtual bool setRadius (const Scalar radius)
 Sets the radius of this cylinder. More...
 
virtual bool setTop (const bool visible)
 Sets whether the top face of the cylinder is visible. More...
 
virtual bool setSide (const bool visible)
 Sets whether the side face of the cylinder is visible. More...
 
virtual bool setBottom (const bool visible)
 Sets whether the bottom face of the cylinder is visible. 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

 Cylinder ()
 Creates a new cylinder object. More...
 
 ~Cylinder () override
 Destructs a cylinder 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...
 
Engineengine () 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...
 
Objectoperator= (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 cylinders.

Constructor & Destructor Documentation

◆ Cylinder()

Ocean::Rendering::Cylinder::Cylinder ( )
protected

Creates a new cylinder object.

◆ ~Cylinder()

Ocean::Rendering::Cylinder::~Cylinder ( )
overrideprotected

Destructs a cylinder object.

Member Function Documentation

◆ bottom()

virtual bool Ocean::Rendering::Cylinder::bottom ( ) const
virtual

Returns whether the bottom face of the cylinder is visible.

Exceptions
NotSupportedExceptionIs thrown if this function is not supported
Returns
True, if so

◆ height()

virtual Scalar Ocean::Rendering::Cylinder::height ( ) const
virtual

Returns the height of this cylinder.

Returns
Height of this cylinder
Exceptions
NotSupportedExceptionIs thrown if this function is not supported

Reimplemented in Ocean::Rendering::GlobalIllumination::GICylinder, and Ocean::Rendering::GLESceneGraph::GLESCylinder.

◆ radius()

virtual Scalar Ocean::Rendering::Cylinder::radius ( ) const
virtual

Returns the radius of this cylinder.

Returns
Radius of this cylinder
Exceptions
NotSupportedExceptionIs thrown if this function is not supported

Reimplemented in Ocean::Rendering::GlobalIllumination::GICylinder, and Ocean::Rendering::GLESceneGraph::GLESCylinder.

◆ setBottom()

virtual bool Ocean::Rendering::Cylinder::setBottom ( const bool  visible)
virtual

Sets whether the bottom face of the cylinder is visible.

Parameters
visibleTrue, if the face has to be visible
Exceptions
NotSupportedExceptionIs thrown if this function is not supported
Returns
True, if succeeded

Reimplemented in Ocean::Rendering::GlobalIllumination::GICylinder.

◆ setHeight()

virtual bool Ocean::Rendering::Cylinder::setHeight ( const Scalar  height)
virtual

Sets the height of this cylinder.

Parameters
heightThe height to set
Returns
True, if the specified height was valid and could be set
Exceptions
NotSupportedExceptionIs thrown if this function is not supported

Reimplemented in Ocean::Rendering::GlobalIllumination::GICylinder, and Ocean::Rendering::GLESceneGraph::GLESCylinder.

◆ setRadius()

virtual bool Ocean::Rendering::Cylinder::setRadius ( const Scalar  radius)
virtual

Sets the radius of this cylinder.

Parameters
radiusRadius to set
Returns
True, if the specified radius was valid and could be set
Exceptions
NotSupportedExceptionIs thrown if this function is not supported

Reimplemented in Ocean::Rendering::GlobalIllumination::GICylinder, and Ocean::Rendering::GLESceneGraph::GLESCylinder.

◆ setSide()

virtual bool Ocean::Rendering::Cylinder::setSide ( const bool  visible)
virtual

Sets whether the side face of the cylinder is visible.

Parameters
visibleTrue, if the face has to be visible
Exceptions
NotSupportedExceptionIs thrown if this function is not supported
Returns
True, if succeeded

Reimplemented in Ocean::Rendering::GlobalIllumination::GICylinder.

◆ setTop()

virtual bool Ocean::Rendering::Cylinder::setTop ( const bool  visible)
virtual

Sets whether the top face of the cylinder is visible.

Parameters
visibleTrue, if the face has to be visible
Exceptions
NotSupportedExceptionIs thrown if this function is not supported
Returns
True, if succeeded

Reimplemented in Ocean::Rendering::GlobalIllumination::GICylinder.

◆ side()

virtual bool Ocean::Rendering::Cylinder::side ( ) const
virtual

Reutrn whether the side face of the cylinder is visible.

Exceptions
NotSupportedExceptionIs thrown if this function is not supported
Returns
True, if so

◆ top()

virtual bool Ocean::Rendering::Cylinder::top ( ) const
virtual

Returns whether the top face of the cylinder is visible.

Exceptions
NotSupportedExceptionIs thrown if this function is not supported
Returns
True, if so

◆ type()

ObjectType Ocean::Rendering::Cylinder::type ( ) const
overridevirtual

Returns the type of this object.

See also
Object::type().

Reimplemented from Ocean::Rendering::Object.

Reimplemented in Ocean::Rendering::GlobalIllumination::GICylinder, and Ocean::Rendering::GLESceneGraph::GLESCylinder.


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