scl::camera Class Reference

#include <camera.h>

Public Member Functions
const matr4 &	GetProjection () const
const matr4 &	GetView () const
const matr4 &	GetViewProjection () const
camera_projection_type	GetProjectionType () const
float	GetFieldOfView () const
float	GetProjectionDistance () const
float	GetFarClip () const
int	GetViewportWidth () const
int	GetViewportHeight () const
float	GetViewportProjectionWidth () const
float	GetViewportProjectionHeight () const
const vec3 &	GetUpDirection () const
const vec3 &	GetDirection () const
const vec3 &	GetRightDirection () const
const vec3 &	GetPosition () const
const vec3 &	GetFocus () const
const shared< frame_buffer > &	GetMainFrameBuffer () const
const shared< frame_buffer > &	GetGBuffer () const
const shared< frame_buffer > &	GetHDRFrameBuffer () const
const shared< frame_buffer > &	GetBlurFrameBuffers (int Index=0) const
void	SetProjectionType (camera_projection_type ProjectionType)
void	SetFieldOfView (float FieldOfView)
void	SetProjectionDistance (float ProjectionDistance)
void	SetFarClip (float FarClip)
void	SetViewportWidth (int ViewportWidth)
void	SetViewportHeight (int ViewportHeight)
void	SetUpDirection (const vec3 &UpDirection)
void	SetDirection (const vec3 &Direction)
void	SetPosition (const vec3 &Position)
void	SetFocus (const vec3 &Focus)
void	SetView (const vec3 &Position, const vec3 &Focus, const vec3 &UpDirection)
void	SetRenderToSwapChain (bool IsSwapChainTarget)
	camera (camera_projection_type ProjectionType, camera_effects Effects={})
	~camera ()
camera &	Resize (int ViewportWidth, int ViewportHeight)
camera &	Rotate (const vec3 &Axis, degrees Angle)
camera &	Move (const vec3 &MoveVector)

Public Attributes
camera_effects	Effects {}

Detailed Description

Renderer virtual camer class.

Definition at line 41 of file camera.h.

Constructor & Destructor Documentation

camera()

scl::camera::camera	(	camera_projection_type	ProjectionType,
		camera_effects	Effects = {}
	)

• Render camera controller default constructor.

Parameters

ProjectionType

- render camera projection type.

Definition at line 171 of file camera.cpp.

                                                                               :
    ProjectionType(ProjectionType), Effects(Effects)
{
    MainFrameBuffer = frame_buffer::Create(frame_buffer_props { 16, 16, 1, false, 1, 0, true });
    GBuffer = frame_buffer::Create(frame_buffer_props { 16, 16, 1, false, 6, 1, true });
    HDRFrameBuffer = frame_buffer::Create(frame_buffer_props { 16, 16, 1, false, 2, 0, true });
    for (int i = 0; i < 2; i++) BlurFrameBuffers[i] = frame_buffer::Create(frame_buffer_props { 16, 16, 1, false, 1, 0, true });
 
    Resize(16, 16);
    SetView({ 0, 3, 10 }, vec3 { 0 }, { 0, 1, 0 });
}

~camera()

scl::camera::~camera ( )

inline

Default camera destructor.

Definition at line 213 of file camera.h.

{}

Member Function Documentation

GetBlurFrameBuffers()

const shared< frame_buffer > & scl::camera::GetBlurFrameBuffers ( int  Index = 0 ) const

inline

Frame buffer for apllying gaussian blur effect getter function.

Definition at line 119 of file camera.h.

{ return BlurFrameBuffers[Index]; }

GetDirection()

const vec3 & scl::camera::GetDirection ( ) const

inline

Camera forward direction getter function.

Definition at line 104 of file camera.h.

{ return LookDirection; }

GetFarClip()

float scl::camera::GetFarClip ( ) const

inline

Distance to far clip plane getter function.

Definition at line 91 of file camera.h.

{ return FarClip; };

GetFieldOfView()

float scl::camera::GetFieldOfView ( ) const

inline

Field of view getter function.

Definition at line 87 of file camera.h.

{ return FieldOfView; }

GetFocus()

const vec3 & scl::camera::GetFocus ( ) const

inline

Camera focus point getter function.

Definition at line 110 of file camera.h.

{ return Focus; }

GetGBuffer()

const shared< frame_buffer > & scl::camera::GetGBuffer ( ) const

inline

Frame buffer for phong model geometry pass.

Definition at line 115 of file camera.h.

{ return GBuffer; }

GetHDRFrameBuffer()

const shared< frame_buffer > & scl::camera::GetHDRFrameBuffer ( ) const

inline

HDR Frame buffer, then tone mapped to destination frame buffer.

Definition at line 117 of file camera.h.

{ return HDRFrameBuffer; }

GetMainFrameBuffer()

const shared< frame_buffer > & scl::camera::GetMainFrameBuffer ( ) const

inline

Main renderer frame buffer.

Definition at line 113 of file camera.h.

{ return MainFrameBuffer; }

GetPosition()

const vec3 & scl::camera::GetPosition ( ) const

inline

Camera postion gertter function.

Definition at line 108 of file camera.h.

{ return Position; }

GetProjection()

const matr4 & scl::camera::GetProjection ( ) const

inline

Camer getter/setter functions.

Camera projection matrix getter function.

Definition at line 78 of file camera.h.

{ return Projection; }

GetProjectionDistance()

float scl::camera::GetProjectionDistance ( ) const

inline

Distance to near clip plane getter function.

Definition at line 89 of file camera.h.

{ return ProjectionDistance; };

GetProjectionType()

camera_projection_type scl::camera::GetProjectionType ( ) const

inline

Camera projection type getter function.

Definition at line 85 of file camera.h.

{ return ProjectionType; }

GetRightDirection()

const vec3 & scl::camera::GetRightDirection ( ) const

inline

Camera right direction getter function.

Definition at line 106 of file camera.h.

{ return RightDirection; }

GetUpDirection()

const vec3 & scl::camera::GetUpDirection ( ) const

inline

Camera up direction getter function.

Definition at line 102 of file camera.h.

{ return UpDirection; }

GetView()

const matr4 & scl::camera::GetView ( ) const

inline

Camera view matrix getter function.

Definition at line 80 of file camera.h.

{ return View; }

GetViewportHeight()

int scl::camera::GetViewportHeight ( ) const

inline

Projection plane height in pixels getter function.

Definition at line 95 of file camera.h.

{ return ViewportHeight; };

GetViewportProjectionHeight()

float scl::camera::GetViewportProjectionHeight ( ) const

inline

Viewport projection plane normalized height getter function.

Definition at line 99 of file camera.h.

{ return ViewportProjectionHeight; }

GetViewportProjectionWidth()

float scl::camera::GetViewportProjectionWidth ( ) const

inline

Viewport projection plane normalized width getter function.

Definition at line 97 of file camera.h.

{ return ViewportProjectionWidth; }

GetViewportWidth()

int scl::camera::GetViewportWidth ( ) const

inline

Projection plane width in pixels getter function.

Definition at line 93 of file camera.h.

{ return ViewportWidth; };

GetViewProjection()

const matr4 & scl::camera::GetViewProjection ( ) const

inline

Camera view projection matrix getter function.

Definition at line 82 of file camera.h.

{ return ViewProjection; }

Move()

scl::camera & scl::camera::Move

(

const vec3 &

MoveVector

)

• Camera movement function.

Parameters

MoveVector

- movement directions.

Returns

self reference.

Definition at line 210 of file camera.cpp.

{
    Position += MoveVector;
    Focus += MoveVector;
 
    InvalidateView();
    return *this;
}

Resize()

scl::camera & scl::camera::Resize	(	int	ViewportWidth,
		int	ViewportHeight
	)

• Set camera project pixel size function..

Parameters

ViewportWidth,ViewportHeight

- new projection plane size in pixels.

Returns

- self reference.

Definition at line 183 of file camera.cpp.

{
    this->ViewportWidth = ViewportWidth;
    this->ViewportHeight = ViewportHeight;
 
    InvalidateProjection();
    InvalidateBuffers();
    return *this;
}

Rotate()

scl::camera & scl::camera::Rotate	(	const vec3 &	Axis,
		degrees	Angle
	)

• Camera rotate function..

Parameters

Axis	- rotation axis.
Angle	- rotation angle (in degree).

Returns

self reference.

Definition at line 193 of file camera.cpp.

{
    matr4 transform =
        matr4::Translate(-Position) *
        matr4::Rotate(Axis, Angle) *
        matr4::Translate(Position);
 
    Focus = transform.TransformPoint(Focus);
    Position = transform.TransformPoint(Position);
    UpDirection = transform.TransformVector(UpDirection);
    LookDirection = (Focus - Position).Normalized();
    RightDirection = LookDirection.Cross(UpDirection).Normalized();
 
    InvalidateView();
    return *this;
}

SetDirection()

void scl::camera::SetDirection

(

const vec3 &

Direction

)

Camera forward direction setter function.

Definition at line 49 of file camera.cpp.

                                                  {
    this->LookDirection = Direction;
    RightDirection = LookDirection.Cross(UpDirection).Normalized();
    InvalidateView();
}

SetFarClip()

void scl::camera::SetFarClip

(

float

FarClip

)

Distance to far clip plane getter function.

Definition at line 28 of file camera.cpp.

                                        {
    this->FarClip = FarClip;
    InvalidateProjection();
}

SetFieldOfView()

void scl::camera::SetFieldOfView

(

float

FieldOfView

)

Field of view getter function.

Definition at line 18 of file camera.cpp.

                                                {
    this->FieldOfView = FieldOfView;
    InvalidateProjection();
}

SetFocus()

void scl::camera::SetFocus

(

const vec3 &

Focus

)

Camer focus point setter function.

Definition at line 62 of file camera.cpp.

                                          {
    this->Focus = Focus;
    LookDirection = (Focus - Position).Normalized();
    RightDirection = LookDirection.Cross(UpDirection).Normalized();
    InvalidateView();
}

SetPosition()

void scl::camera::SetPosition

(

const vec3 &

Position

)

Camer position setter function.

Definition at line 55 of file camera.cpp.

                                                {
    this->Position = Position;
    LookDirection = (Focus - Position).Normalized();
    RightDirection = LookDirection.Cross(UpDirection).Normalized();
    InvalidateView();
}

SetProjectionDistance()

void scl::camera::SetProjectionDistance

(

float

ProjectionDistance

)

Distance to near clip plane getter function.

Definition at line 23 of file camera.cpp.

                                                              {
    this->ProjectionDistance = ProjectionDistance;
    InvalidateProjection();
}

SetProjectionType()

void scl::camera::SetProjectionType

(

camera_projection_type

ProjectionType

)

Camera projection type setter function.

Definition at line 13 of file camera.cpp.

                                                                       {
    this->ProjectionType = ProjectionType;
    InvalidateProjection();
}

SetRenderToSwapChain()

void scl::camera::SetRenderToSwapChain

(

bool

IsSwapChainTarget

)

• Set flag, showing wheather camera main buffer is swap chain target or not.

Parameters

IsSwapChainTarget

- flag, showing wheather camera main buffer is swap chain target or not

Returns

None.

Definition at line 79 of file camera.cpp.

{
    frame_buffer_props current_props = MainFrameBuffer->GetFrameBufferProps();
    if (current_props.IsSwapChainTarget != IsSwapChainTarget)
    {
        current_props.IsSwapChainTarget = IsSwapChainTarget;
        MainFrameBuffer->SetFrameBufferProps(current_props);
    }
}

SetUpDirection()

void scl::camera::SetUpDirection

(

const vec3 &

UpDirection

)

Camera up direction setter function.

Definition at line 43 of file camera.cpp.

                                                      {
    this->UpDirection = UpDirection;
    RightDirection = LookDirection.Cross(UpDirection).Normalized();
    InvalidateView();
}

SetView()

void scl::camera::SetView	(	const vec3 &	Position,
		const vec3 &	Focus,
		const vec3 &	UpDirection
	)

• Set view matrix by camera translation parametrs.

Parameters

Position	- camera position.
Focus	- camera focusing point.
UpDirection	- camera up direction.

Definition at line 69 of file camera.cpp.

{
    this->Position = Position;
    this->UpDirection = UpDirection;
    this->Focus = Focus;
    LookDirection = (Focus - Position).Normalized();
    RightDirection = LookDirection.Cross(UpDirection).Normalized();
    InvalidateView();
}

SetViewportHeight()

void scl::camera::SetViewportHeight

(

int

ViewportHeight

)

Projection plane height in pixels getter function.

Definition at line 38 of file camera.cpp.

                                                    {
    this->ViewportHeight = ViewportHeight;
    InvalidateProjection();
}

SetViewportWidth()

void scl::camera::SetViewportWidth

(

int

ViewportWidth

)

Projection plane width in pixels getter function.

Definition at line 33 of file camera.cpp.

                                                  {
    this->ViewportWidth = ViewportWidth;
    InvalidateProjection();
}

Member Data Documentation

Effects

camera_effects scl::camera::Effects {}

Frame buffer for apllying gaussian blur effect.

Camera rendering effects data.

Definition at line 74 of file camera.h.

---

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

• core/resources/camera.h
• core/resources/camera.cpp