RealmOA Library

oa::FnCamera

FnCamera class in the OA Ui public surface.

ClC++ public headers

Static Public Methods

static void oa::FnCamera::fitToWindow(oa::Camera & inCamera, oa::F32 inWindowWidth, oa::F32 inWindowHeight)
static oa::F32 oa::FnCamera::getAspectRatio(const oa::Camera & inCamera)
static oa::F32 oa::FnCamera::getEffectiveFovY(const oa::Camera & inCamera)
static oa::F32 oa::FnCamera::getFar(const oa::Camera & inCamera)
static oa::F32 oa::FnCamera::getFocalLength(const oa::Camera & inCamera)
static oa::F32 oa::FnCamera::getFovY(const oa::Camera & inCamera)
static oa::F32 oa::FnCamera::getNear(const oa::Camera & inCamera)
static oa::vlm::Vec2 oa::FnCamera::getOffset(const oa::Camera & inCamera)
static oa::vlm::Vec2 oa::FnCamera::getOrthographicSize(const oa::Camera & inCamera)
static oa::vlm::Mat4 oa::FnCamera::getProjectionMatrix(const oa::Camera & inCamera)
static oa::CameraProjection oa::FnCamera::getProjectionType(const oa::Camera & inCamera)
static oa::F32 oa::FnCamera::getSensorHeight(const oa::Camera & inCamera)
static oa::vlm::Mat4 oa::FnCamera::getViewMatrix(const oa::Camera & inCamera)
static oa::vlm::Mat4 oa::FnCamera::getViewProjectionMatrix(const oa::Camera & inCamera)
static oa::F32 oa::FnCamera::getZoom(const oa::Camera & inCamera)
static void oa::FnCamera::initOrthographic(oa::Camera & inCamera, oa::F32 inWidth = 1.0F, oa::F32 inHeight = 1.0F, oa::F32 inNear = 0.0F, oa::F32 inFar = 1.0F)
static void oa::FnCamera::initPerspective(oa::Camera & inCamera, const oa::vlm::Vec3 & inPosition = {0.0F, 2.0F, 5.0F}, 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)
static void oa::FnCamera::orbitSetYawPitch(oa::Camera & inCamera, oa::F32 inYaw, oa::F32 inPitch)
static void oa::FnCamera::orbitYawPitch(oa::Camera & inCamera, oa::F32 inYawDelta, oa::F32 inPitchDelta)
static void oa::FnCamera::setAspectRatio(oa::Camera & inCamera, oa::F32 inAspect)
static void oa::FnCamera::setFocalLength(oa::Camera & inCamera, oa::F32 inFocalLengthMm)
static void oa::FnCamera::setFovY(oa::Camera & inCamera, oa::F32 inFovY)
static void oa::FnCamera::setNearFar(oa::Camera & inCamera, oa::F32 inNear, oa::F32 inFar)
static void oa::FnCamera::setOffset(oa::Camera & inCamera, oa::F32 inOffsetX, oa::F32 inOffsetY)
static void oa::FnCamera::setOrbitDistance(oa::Camera & inCamera, oa::F32 inDistance)
static void oa::FnCamera::setOrbitTarget(oa::Camera & inCamera, const oa::vlm::Vec3 & inTarget)
static void oa::FnCamera::setOrthographic(oa::Camera & inCamera, oa::F32 inWidth, oa::F32 inHeight, oa::F32 inNear = 0.0F, oa::F32 inFar = 1.0F)
static void oa::FnCamera::setPerspective(oa::Camera & inCamera, oa::F32 inFovY, oa::F32 inAspect, oa::F32 inNear, oa::F32 inFar)
static void oa::FnCamera::setSensorHeight(oa::Camera & inCamera, oa::F32 inSensorHeightMm)
static void oa::FnCamera::setZoom(oa::Camera & inCamera, oa::F32 inZoom)

Constructor & Destructor Documentation

oa::FnCamera::FnCamera()
No public source comment is attached to this declaration.

Public Method Documentation

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

Parameters

inCamera
oa::Camera &

—

inWindowWidth
oa::F32

—

inWindowHeight
oa::F32

—

Returns

void

The declared return value.

static oa::F32 oa::FnCamera::getAspectRatio( const oa::Camera & inCamera )
No public source comment is attached to this declaration.

Parameters

inCamera
const oa::Camera &

—

Returns

oa::F32

The declared return value.

static oa::F32 oa::FnCamera::getEffectiveFovY( const oa::Camera & inCamera )
No public source comment is attached to this declaration.

Parameters

inCamera
const oa::Camera &

—

Returns

oa::F32

The declared return value.

static oa::F32 oa::FnCamera::getFar( const oa::Camera & inCamera )
No public source comment is attached to this declaration.

Parameters

inCamera
const oa::Camera &

—

Returns

oa::F32

The declared return value.

static oa::F32 oa::FnCamera::getFocalLength( const oa::Camera & inCamera )
No public source comment is attached to this declaration.

Parameters

inCamera
const oa::Camera &

—

Returns

oa::F32

The declared return value.

static oa::F32 oa::FnCamera::getFovY( const oa::Camera & inCamera )
No public source comment is attached to this declaration.

Parameters

inCamera
const oa::Camera &

—

Returns

oa::F32

The declared return value.

static oa::F32 oa::FnCamera::getNear( const oa::Camera & inCamera )
No public source comment is attached to this declaration.

Parameters

inCamera
const oa::Camera &

—

Returns

oa::F32

The declared return value.

static oa::vlm::Vec2 oa::FnCamera::getOffset( const oa::Camera & inCamera )
No public source comment is attached to this declaration.

Parameters

inCamera
const oa::Camera &

—

Returns

oa::vlm::Vec2

The declared return value.

static oa::vlm::Vec2 oa::FnCamera::getOrthographicSize( const oa::Camera & inCamera )
No public source comment is attached to this declaration.

Parameters

inCamera
const oa::Camera &

—

Returns

oa::vlm::Vec2

The declared return value.

static oa::vlm::Mat4 oa::FnCamera::getProjectionMatrix( const oa::Camera & inCamera )
No public source comment is attached to this declaration.

Parameters

inCamera
const oa::Camera &

—

Returns

oa::vlm::Mat4

The declared return value.

static oa::CameraProjection oa::FnCamera::getProjectionType( const oa::Camera & inCamera )
No public source comment is attached to this declaration.

Parameters

inCamera
const oa::Camera &

—

Returns

oa::CameraProjection

The declared return value.

static oa::F32 oa::FnCamera::getSensorHeight( const oa::Camera & inCamera )
No public source comment is attached to this declaration.

Parameters

inCamera
const oa::Camera &

—

Returns

oa::F32

The declared return value.

static oa::vlm::Mat4 oa::FnCamera::getViewMatrix( const oa::Camera & inCamera )
No public source comment is attached to this declaration.

Parameters

inCamera
const oa::Camera &

—

Returns

oa::vlm::Mat4

The declared return value.

static oa::vlm::Mat4 oa::FnCamera::getViewProjectionMatrix( const oa::Camera & inCamera )
No public source comment is attached to this declaration.

Parameters

inCamera
const oa::Camera &

—

Returns

oa::vlm::Mat4

The declared return value.

static oa::F32 oa::FnCamera::getZoom( const oa::Camera & inCamera )
No public source comment is attached to this declaration.

Parameters

inCamera
const oa::Camera &

—

Returns

oa::F32

The declared return value.

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

Parameters

inCamera
oa::Camera &

—

inWidth
oa::F32

Default: 1.0F

inHeight
oa::F32

Default: 1.0F

inNear
oa::F32

Default: 0.0F

inFar
oa::F32

Default: 1.0F

Returns

void

The declared return value.

static void oa::FnCamera::initPerspective( oa::Camera & inCamera, const oa::vlm::Vec3 & inPosition = {0.0F, 2.0F, 5.0F}, 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

inCamera
oa::Camera &

—

inPosition
const oa::vlm::Vec3 &

Default: {0.0F, 2.0F, 5.0F}

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

Returns

void

The declared return value.

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

Parameters

inCamera
oa::Camera &

—

inYaw
oa::F32

—

inPitch
oa::F32

—

Returns

void

The declared return value.

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

Parameters

inCamera
oa::Camera &

—

inYawDelta
oa::F32

—

inPitchDelta
oa::F32

—

Returns

void

The declared return value.

static void oa::FnCamera::setAspectRatio( oa::Camera & inCamera, oa::F32 inAspect )
No public source comment is attached to this declaration.

Parameters

inCamera
oa::Camera &

—

inAspect
oa::F32

—

Returns

void

The declared return value.

static void oa::FnCamera::setFocalLength( oa::Camera & inCamera, oa::F32 inFocalLengthMm )
No public source comment is attached to this declaration.

Parameters

inCamera
oa::Camera &

—

inFocalLengthMm
oa::F32

—

Returns

void

The declared return value.

static void oa::FnCamera::setFovY( oa::Camera & inCamera, oa::F32 inFovY )
No public source comment is attached to this declaration.

Parameters

inCamera
oa::Camera &

—

inFovY
oa::F32

—

Returns

void

The declared return value.

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

Parameters

inCamera
oa::Camera &

—

inNear
oa::F32

—

inFar
oa::F32

—

Returns

void

The declared return value.

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

Parameters

inCamera
oa::Camera &

—

inOffsetX
oa::F32

—

inOffsetY
oa::F32

—

Returns

void

The declared return value.

static void oa::FnCamera::setOrbitDistance( oa::Camera & inCamera, oa::F32 inDistance )
No public source comment is attached to this declaration.

Parameters

inCamera
oa::Camera &

—

inDistance
oa::F32

—

Returns

void

The declared return value.

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

Parameters

inCamera
oa::Camera &

—

inTarget
const oa::vlm::Vec3 &

—

Returns

void

The declared return value.

static void oa::FnCamera::setOrthographic( oa::Camera & inCamera, 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

inCamera
oa::Camera &

—

inWidth
oa::F32

—

inHeight
oa::F32

—

inNear
oa::F32

Default: 0.0F

inFar
oa::F32

Default: 1.0F

Returns

void

The declared return value.

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

Parameters

inCamera
oa::Camera &

—

inFovY
oa::F32

—

inAspect
oa::F32

—

inNear
oa::F32

—

inFar
oa::F32

—

Returns

void

The declared return value.

static void oa::FnCamera::setSensorHeight( oa::Camera & inCamera, oa::F32 inSensorHeightMm )
No public source comment is attached to this declaration.

Parameters

inCamera
oa::Camera &

—

inSensorHeightMm
oa::F32

—

Returns

void

The declared return value.

static void oa::FnCamera::setZoom( oa::Camera & inCamera, oa::F32 inZoom )
No public source comment is attached to this declaration.

Parameters

inCamera
oa::Camera &

—

inZoom
oa::F32

—

Returns

void

The declared return value.