Ocean::Rendering::ParallelView Class Reference
This class is the base class for all parallel views. More...
Inheritance diagram for Ocean::Rendering::ParallelView:
Public Member Functions | |
| ObjectType | type () const override |
| Returns the type of this object. More... | |
 Public Member Functions inherited from Ocean::Rendering::View | |
| virtual Scalar | aspectRatio () const |
| Returns the aspect ratio of this view. More... | |
| virtual Scalar | nearDistance () const |
| Returns the distance to the near clipping plane. More... | |
| virtual Scalar | farDistance () const |
| Returns the distance to the far clipping plane. More... | |
| virtual HomogenousMatrix4 | transformation () const |
| Returns the transformation between view and world (the extrinsic camera data, the inverse of the known View Matrix). More... | |
| virtual SquareMatrix4 | projectionMatrix () const |
| Returns the projection matrix of this view. More... | |
| virtual RGBAColor | backgroundColor () const |
| Returns the background color of the view. More... | |
| virtual BackgroundRef | background () const |
| Returns the currently used background of the view. More... | |
| virtual Backgrounds | backgrounds () const |
| Returns all defined background objects. More... | |
| virtual bool | useHeadlight () const |
| Returns whether the head light is enabled. More... | |
| virtual PhantomAttribute::PhantomMode | phantomMode () const |
| Returns the phantom mode of this view. More... | |
| virtual Line3 | viewingRay (const Scalar x, const Scalar y, const unsigned int width, const unsigned int height) const |
| Returns a viewing ray into the scene. More... | |
| virtual bool | setAspectRatio (const Scalar aspectRatio) |
| Sets the aspect ratio of this view. More... | |
| virtual bool | setNearDistance (const Scalar distance) |
| Sets the distance to the near clipping plane. More... | |
| virtual bool | setFarDistance (const Scalar distance) |
| Sets the distance to the far clipping plane. More... | |
| virtual bool | setNearFarDistance (const Scalar nearDistance, const Scalar farDistance) |
| Sets the distance to the near and far clipping plane. More... | |
| virtual void | setTransformation (const HomogenousMatrix4 &world_T_view) |
| Sets the position and orientation of the view in world coordinates (the extrinsic camera data, the inverse of the known View Matrix). More... | |
| virtual bool | setBackgroundColor (const RGBAColor &color) |
| Sets the background color of the view. More... | |
| virtual void | addBackground (const BackgroundRef &background) |
| Adds a new background object to the background stack of the view. More... | |
| virtual void | removeBackground (const BackgroundRef &background) |
| Removes a background object from the background stack of this view. More... | |
| virtual void | setUseHeadlight (const bool state) |
| Sets whether the headlight should be activated. More... | |
| virtual bool | setPhantomMode (const PhantomAttribute::PhantomMode mode) |
| Sets the phantom mode of this view. More... | |
| virtual void | fitCamera (const NodeRef &node=NodeRef()) |
| Fits the camera to a given node. More... | |
| 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 | |
| ParallelView () | |
| Creates a new parallel view object. More... | |
| ~ParallelView () override | |
| Destructs a parallel view object. More... | |
| Protected Member Functions inherited from Ocean::Rendering::View | |
| View () | |
| Creates a new view object. More... | |
| ~View () override | |
| Destructs a view 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... | |
Detailed Description
This class is the base class for all parallel views.
Constructor & Destructor Documentation
◆ ParallelView()
|
protected |
Creates a new parallel view object.
◆ ~ParallelView()
|
overrideprotected |
Destructs a parallel view object.
Member Function Documentation
◆ type()
|
overridevirtual |
Returns the type of this object.
- See also
- Object::type().
Reimplemented from Ocean::Rendering::Object.
The documentation for this class was generated from the following file:
