RealmOA Library

oa::Camera

Camera class in the OA Ui public surface.

ClC++ public headers

Public Methods

void oa::Camera::fitToWindow(oa::F32 inWindowWidth, oa::F32 inWindowHeight)
oa::F32 oa::Camera::getAspectRatio()
oa::F32 oa::Camera::getEffectiveFovY()
oa::F32 oa::Camera::getFar()
oa::F32 oa::Camera::getFocalLength()
oa::F32 oa::Camera::getFovY()
oa::F32 oa::Camera::getNear()
oa::vlm::Vec2 oa::Camera::getOffset()
oa::vlm::Vec2 oa::Camera::getOrthographicSize()
oa::vlm::Mat4 oa::Camera::getProjectionMatrix()
CameraProjection oa::Camera::getProjectionType()
oa::F32 oa::Camera::getSensorHeight()
const oa::Transform & oa::Camera::getTransform()
oa::Transform & oa::Camera::getTransform()
oa::vlm::Mat4 oa::Camera::getViewMatrix()
oa::vlm::Mat4 oa::Camera::getViewProjectionMatrix()
oa::F32 oa::Camera::getZoom()
void oa::Camera::orbitSetYawPitch(oa::F32 inYaw, oa::F32 inPitch)
void oa::Camera::orbitYawPitch(oa::F32 inYawDelta, oa::F32 inPitchDelta)
void oa::Camera::setAspectRatio(oa::F32 inAspect)
void oa::Camera::setFocalLength(oa::F32 inFocalLengthMm)
void oa::Camera::setFovY(oa::F32 inFovY)
void oa::Camera::setNearFar(oa::F32 inNear, oa::F32 inFar)
void oa::Camera::setOffset(oa::F32 inOffsetX, oa::F32 inOffsetY)
void oa::Camera::setOrbitDistance(oa::F32 inDistance)
void oa::Camera::setOrbitTarget(const oa::vlm::Vec3 & inTarget)
void oa::Camera::setOrthographic(oa::F32 inWidth, oa::F32 inHeight, oa::F32 inNear = 0.0F, oa::F32 inFar = 1.0F)
void oa::Camera::setPerspective(oa::F32 inFovY, oa::F32 inAspect, oa::F32 inNear, oa::F32 inFar)
void oa::Camera::setSensorHeight(oa::F32 inSensorHeightMm)
void oa::Camera::setZoom(oa::F32 inZoom)

Constructor & Destructor Documentation

oa::Camera::Camera()
Perspective camera at (0, 0, 5), looking along -Z.
oa::Camera::Camera( const oa::vlm::Vec3 & inPosition, const oa::vlm::Vec3 & inTarget = {0.0F, 0.0F, 0.0F}, oa::F32 inFovY = 60.0F, oa::F32 inAspect = 1280.0F / 720.0F, oa::F32 inNear = 0.1F, oa::F32 inFar = 10000.0F )
No public source comment is attached to this declaration.

Parameters

inPosition
const oa::vlm::Vec3 &

—

inTarget
const oa::vlm::Vec3 &

Default: {0.0F, 0.0F, 0.0F}

inFovY
oa::F32

Default: 60.0F

inAspect
oa::F32

Default: 1280.0F / 720.0F

inNear
oa::F32

Default: 0.1F

inFar
oa::F32

Default: 10000.0F

oa::Camera::Camera( oa::F32 inWidth, oa::F32 inHeight, oa::F32 inNear = 0.0F, oa::F32 inFar = 100.0F )
Orthographic camera for image and video viewing.

Parameters

inWidth
oa::F32

—

inHeight
oa::F32

—

inNear
oa::F32

Default: 0.0F

inFar
oa::F32

Default: 100.0F

Public Method Documentation

void oa::Camera::fitToWindow( oa::F32 inWindowWidth, oa::F32 inWindowHeight )
No public source comment is attached to this declaration.

Parameters

inWindowWidth
oa::F32

—

inWindowHeight
oa::F32

—

Returns

void

The declared return value.

oa::F32 oa::Camera::getAspectRatio()
No public source comment is attached to this declaration.

Returns

oa::F32

The declared return value.

oa::F32 oa::Camera::getEffectiveFovY()
No public source comment is attached to this declaration.

Returns

oa::F32

The declared return value.

oa::F32 oa::Camera::getFar()
No public source comment is attached to this declaration.

Returns

oa::F32

The declared return value.

oa::F32 oa::Camera::getFocalLength()
No public source comment is attached to this declaration.

Returns

oa::F32

The declared return value.

oa::F32 oa::Camera::getFovY()
No public source comment is attached to this declaration.

Returns

oa::F32

The declared return value.

oa::F32 oa::Camera::getNear()
No public source comment is attached to this declaration.

Returns

oa::F32

The declared return value.

oa::vlm::Vec2 oa::Camera::getOffset()
No public source comment is attached to this declaration.

Returns

oa::vlm::Vec2

The declared return value.

oa::vlm::Vec2 oa::Camera::getOrthographicSize()
No public source comment is attached to this declaration.

Returns

oa::vlm::Vec2

The declared return value.

oa::vlm::Mat4 oa::Camera::getProjectionMatrix()
No public source comment is attached to this declaration.

Returns

oa::vlm::Mat4

The declared return value.

CameraProjection oa::Camera::getProjectionType()
No public source comment is attached to this declaration.

Returns

CameraProjection

The declared return value.

oa::F32 oa::Camera::getSensorHeight()
No public source comment is attached to this declaration.

Returns

oa::F32

The declared return value.

const oa::Transform & oa::Camera::getTransform()
No public source comment is attached to this declaration.

Returns

const oa::Transform &

The declared return value.

oa::Transform & oa::Camera::getTransform()
No public source comment is attached to this declaration.

Returns

oa::Transform &

The declared return value.

oa::vlm::Mat4 oa::Camera::getViewMatrix()
No public source comment is attached to this declaration.

Returns

oa::vlm::Mat4

The declared return value.

oa::vlm::Mat4 oa::Camera::getViewProjectionMatrix()
No public source comment is attached to this declaration.

Returns

oa::vlm::Mat4

The declared return value.

oa::F32 oa::Camera::getZoom()
No public source comment is attached to this declaration.

Returns

oa::F32

The declared return value.

void oa::Camera::orbitSetYawPitch( oa::F32 inYaw, oa::F32 inPitch )
No public source comment is attached to this declaration.

Parameters

inYaw
oa::F32

—

inPitch
oa::F32

—

Returns

void

The declared return value.

void oa::Camera::orbitYawPitch( oa::F32 inYawDelta, oa::F32 inPitchDelta )
No public source comment is attached to this declaration.

Parameters

inYawDelta
oa::F32

—

inPitchDelta
oa::F32

—

Returns

void

The declared return value.

void oa::Camera::setAspectRatio( oa::F32 inAspect )
No public source comment is attached to this declaration.

Parameters

inAspect
oa::F32

—

Returns

void

The declared return value.

void oa::Camera::setFocalLength( oa::F32 inFocalLengthMm )
No public source comment is attached to this declaration.

Parameters

inFocalLengthMm
oa::F32

—

Returns

void

The declared return value.

void oa::Camera::setFovY( oa::F32 inFovY )
No public source comment is attached to this declaration.

Parameters

inFovY
oa::F32

—

Returns

void

The declared return value.

void oa::Camera::setNearFar( oa::F32 inNear, oa::F32 inFar )
No public source comment is attached to this declaration.

Parameters

inNear
oa::F32

—

inFar
oa::F32

—

Returns

void

The declared return value.

void oa::Camera::setOffset( oa::F32 inOffsetX, oa::F32 inOffsetY )
No public source comment is attached to this declaration.

Parameters

inOffsetX
oa::F32

—

inOffsetY
oa::F32

—

Returns

void

The declared return value.

void oa::Camera::setOrbitDistance( oa::F32 inDistance )
No public source comment is attached to this declaration.

Parameters

inDistance
oa::F32

—

Returns

void

The declared return value.

void oa::Camera::setOrbitTarget( const oa::vlm::Vec3 & inTarget )
No public source comment is attached to this declaration.

Parameters

inTarget
const oa::vlm::Vec3 &

—

Returns

void

The declared return value.

void oa::Camera::setOrthographic( oa::F32 inWidth, oa::F32 inHeight, oa::F32 inNear = 0.0F, oa::F32 inFar = 1.0F )
No public source comment is attached to this declaration.

Parameters

inWidth
oa::F32

—

inHeight
oa::F32

—

inNear
oa::F32

Default: 0.0F

inFar
oa::F32

Default: 1.0F

Returns

void

The declared return value.

void oa::Camera::setPerspective( oa::F32 inFovY, oa::F32 inAspect, oa::F32 inNear, oa::F32 inFar )
No public source comment is attached to this declaration.

Parameters

inFovY
oa::F32

—

inAspect
oa::F32

—

inNear
oa::F32

—

inFar
oa::F32

—

Returns

void

The declared return value.

void oa::Camera::setSensorHeight( oa::F32 inSensorHeightMm )
No public source comment is attached to this declaration.

Parameters

inSensorHeightMm
oa::F32

—

Returns

void

The declared return value.

void oa::Camera::setZoom( oa::F32 inZoom )
No public source comment is attached to this declaration.

Parameters

inZoom
oa::F32

—

Returns

void

The declared return value.