Inviwo 0.9.12-pre
Inviwo documentation
Loading...
Searching...
No Matches
inviwo::PlotCamera Class Referencefinal

Orthographic camera for plotting that does not preserve aspect ratios. More...

#include <inviwo/core/datastructures/camera/plotcamera.h>

Inheritance diagram for inviwo::PlotCamera:

Public Member Functions

virtual PlotCamera * clone () const override
virtual void configureProperties (CameraProperty &cp, bool attach) override
virtual void deserialize (Deserializer &d) override
virtual std::string_view getClassIdentifier () const override
virtual dvec4 getClipPosFromNormalizedDeviceCoords (const dvec3 &ndcCoords) const override
 Convert from normalized device coordinates (xyz in [-1 1]) to clip coordinates, where z value of -1 correspond to the near plane and 1 to the far plane. Coordinates outside of the [-1 1]^3 range will be clipped.
dvec2 getSize () const
PlotCamera & operator= (const PlotCamera &other)
PlotCamera & operator= (PlotCamera &&other) noexcept
 PlotCamera (const PlotCamera &other)
 PlotCamera (dvec3 lookFrom=cameradefaults::lookFrom, dvec3 lookTo=cameradefaults::lookTo, dvec3 lookUp=cameradefaults::lookUp, double nearPlane=cameradefaults::nearPlane, double farPlane=cameradefaults::farPlane, double aspectRatio=cameradefaults::aspectRatio, dvec2 size=dvec2{300, 300})
 PlotCamera (PlotCamera &&other) noexcept
virtual void serialize (Serializer &s) const override
void setSize (dvec2 size)
virtual void updateFrom (const Camera &source) override
virtual void zoom (const ZoomOptions &opts) override
Public Member Functions inherited from inviwo::Camera
 Camera (Camera &&other) noexcept=default
 Camera (const Camera &other)=default
 Camera (dvec3 lookFrom, dvec3 lookTo, dvec3 lookUp, double nearPlane, double farPlane, double aspectRatio)
 Create a camera.
virtual double getAspectRatio () const
dvec3 getDirection () const
 Get unnormalized direction of camera: lookTo - lookFrom.
double getFarPlaneDist () const
const dmat4 & getInverseProjectionMatrix () const
const dmat4 & getInverseViewMatrix () const
const dvec3 & getLookFrom () const
dvec3 getLookRight () const
const dvec3 & getLookTo () const
const dvec3 & getLookUp () const
double getNearPlaneDist () const
dvec3 getNormalizedDeviceFromNormalizedScreenAtFocusPointDepth (const dvec2 &normalizedScreenCoord) const
const dmat4 & getProjectionMatrix () const
const dmat4 & getViewMatrix () const
dvec3 getWorldPosFromNormalizedDeviceCoords (const dvec3 &ndcCoords) const
 Convert from normalized device coordinates (xyz in [-1 1]) to world coordinates.
Cameraoperator= (Camera &&other) noexcept=default
Cameraoperator= (const Camera &other)=default
virtual void setAspectRatio (double val)
virtual void setFarPlaneDist (double distance)
 Set distance to the far plane from lookFrom.
void setLook (dvec3 lookFrom, dvec3 lookTo, dvec3 lookUp)
virtual void setLookFrom (dvec3 val)
virtual void setLookTo (dvec3 val)
virtual void setLookUp (dvec3 val)
virtual void setNearPlaneDist (double distance)
 Set distance to the near plane from lookFrom.

Static Public Attributes

static constexpr std::string_view classIdentifier {"PlotCamera"}

Protected Member Functions

virtual dmat4 calculateProjectionMatrix () const override
 Calculate and return the projection matrix for the camera.
virtual bool equal (const Camera &other) const override
Protected Member Functions inherited from inviwo::Camera
virtual dmat4 calculateViewMatrix () const
bool equalTo (const Camera &other) const
void invalidateProjectionMatrix ()
void invalidateViewMatrix ()

Protected Attributes

dvec2 size_
Protected Attributes inherited from inviwo::Camera
double aspectRatio_
CameraPropertycamprop_ = nullptr
double farPlaneDist_
 Distance to the far plane from lookFrom.
bool invalidProjectionMatrix_
bool invalidViewMatrix_
dmat4 inverseProjectionMatrix_
dmat4 inverseViewMatrix_
dvec3 lookFrom_
dvec3 lookTo_
dvec3 lookUp_
double nearPlaneDist_
 Distance to the near plane from lookFrom.
dmat4 projectionMatrix_
dmat4 viewMatrix_

Detailed Description

Orthographic camera for plotting that does not preserve aspect ratios.

The PlotCamera is a specialized orthographic camera designed for plotting and visualization tasks where maintaining the original aspect ratio of the view is not required. Unlike standard orthographic cameras, PlotCamera allows independent scaling of the view along each axis, enabling flexible and non-uniform projections suitable for data visualization.

Member Function Documentation

◆ calculateProjectionMatrix()

virtual dmat4 inviwo::PlotCamera::calculateProjectionMatrix ( ) const
overrideprotectedvirtual

Calculate and return the projection matrix for the camera.

Implement this function to provide your own projection computation functionality. For example orthogonal or perspective projection. This function will be called when the projection matrix is invalid.

See also
PerspectiveCamera
OrthographicCamera

Implements inviwo::Camera.

◆ clone()

virtual PlotCamera * inviwo::PlotCamera::clone ( ) const
overridevirtual

Implements inviwo::Camera.

◆ configureProperties()

virtual void inviwo::PlotCamera::configureProperties ( CameraProperty & cp,
bool attach )
overridevirtual

Reimplemented from inviwo::Camera.

◆ deserialize()

virtual void inviwo::PlotCamera::deserialize ( Deserializer & d)
overridevirtual

Reimplemented from inviwo::Camera.

◆ equal()

virtual bool inviwo::PlotCamera::equal ( const Camera & other) const
overrideprotectedvirtual

Implements inviwo::Camera.

◆ getClassIdentifier()

virtual std::string_view inviwo::PlotCamera::getClassIdentifier ( ) const
overridevirtual

Implements inviwo::Camera.

◆ getClipPosFromNormalizedDeviceCoords()

virtual dvec4 inviwo::PlotCamera::getClipPosFromNormalizedDeviceCoords ( const dvec3 & ndcCoords) const
overridevirtual

Convert from normalized device coordinates (xyz in [-1 1]) to clip coordinates, where z value of -1 correspond to the near plane and 1 to the far plane. Coordinates outside of the [-1 1]^3 range will be clipped.

Parameters
ndcCoordsxyz clip-coordinates in [-1 1]^3, and the clip w-coordinate used for perspective division.
Returns
Clip space position

Reimplemented from inviwo::Camera.

◆ serialize()

virtual void inviwo::PlotCamera::serialize ( Serializer & s) const
overridevirtual

Reimplemented from inviwo::Camera.

◆ updateFrom()

virtual void inviwo::PlotCamera::updateFrom ( const Camera & source)
overridevirtual

Reimplemented from inviwo::Camera.

◆ zoom()

virtual void inviwo::PlotCamera::zoom ( const ZoomOptions & opts)
overridevirtual

Implements inviwo::Camera.


The documentation for this class was generated from the following file:
  • include/inviwo/core/datastructures/camera/plotcamera.h