oa::Navigation

Navigation class in the OA Ui public surface.

ClC++ public headers

Public Methods

oa::Status oa::Navigation::fitToWindow(bool inAnimate = false)

PlaneCamera oa::Navigation::getPlaneCamera()

oa::Result<bool> oa::Navigation::handleEvent(const UiEvent & inEvent)

bool oa::Navigation::isAnimating()

bool oa::Navigation::isPanning()

bool oa::Navigation::isPinching()

oa::Status oa::Navigation::keyboardFitToWindow()

oa::Status oa::Navigation::keyboardPan(oa::F32 inDirX, oa::F32 inDirY)

oa::Status oa::Navigation::keyboardReset()

oa::Status oa::Navigation::keyboardZoomIn()

oa::Status oa::Navigation::keyboardZoomOut()

oa::Status oa::Navigation::keyboardZoomTo100()

const oa::vlm::Vec3 & oa::Navigation::movement()

oa::Status oa::Navigation::panBy(oa::F32 inDx, oa::F32 inDy)

oa::F32 oa::Navigation::panX()

oa::F32 oa::Navigation::panY()

void oa::Navigation::setCapturePointer(CaptureFn inFn)

oa::Status oa::Navigation::setContentSize(oa::F32 inWidth, oa::F32 inHeight)

oa::Status oa::Navigation::setWindowSize(oa::F32 inWidth, oa::F32 inHeight)

oa::Status oa::Navigation::update(oa::F32 inDeltaMs)

oa::Status oa::Navigation::validate()

oa::F32 oa::Navigation::zoom()

oa::Status oa::Navigation::zoomTo(oa::F32 inZoom, oa::F32 inAnchorX, oa::F32 inAnchorY, bool inAnimate = true)

Constructor & Destructor Documentation

oa::Navigation::Navigation(
	const NavigationConfig & inConfig = {}
)

No public source comment is attached to this declaration.

Parameters

inConfig

const NavigationConfig &

Default: {}

Public Method Documentation

oa::Status oa::Navigation::fitToWindow(
	bool inAnimate = false
)

No public source comment is attached to this declaration.

Parameters

inAnimate

bool

Default: false

Returns

oa::Status

The declared return value.

PlaneCamera oa::Navigation::getPlaneCamera()

No public source comment is attached to this declaration.

Returns

PlaneCamera

The declared return value.

oa::Result<bool> oa::Navigation::handleEvent(
	const UiEvent & inEvent
)

No public source comment is attached to this declaration.

Parameters

inEvent

const UiEvent &

—

Returns

oa::Result<bool>

The declared return value.

bool oa::Navigation::isAnimating()

No public source comment is attached to this declaration.

Returns

bool

The declared return value.

bool oa::Navigation::isPanning()

No public source comment is attached to this declaration.

Returns

bool

The declared return value.

bool oa::Navigation::isPinching()

No public source comment is attached to this declaration.

Returns

bool

The declared return value.

oa::Status oa::Navigation::keyboardFitToWindow()

No public source comment is attached to this declaration.

Returns

oa::Status

The declared return value.

oa::Status oa::Navigation::keyboardPan(
	oa::F32 inDirX,
	oa::F32 inDirY
)

No public source comment is attached to this declaration.

Parameters

inDirX

oa::F32

—

inDirY

oa::F32

—

Returns

oa::Status

The declared return value.

oa::Status oa::Navigation::keyboardReset()

No public source comment is attached to this declaration.

Returns

oa::Status

The declared return value.

oa::Status oa::Navigation::keyboardZoomIn()

No public source comment is attached to this declaration.

Returns

oa::Status

The declared return value.

oa::Status oa::Navigation::keyboardZoomOut()

No public source comment is attached to this declaration.

Returns

oa::Status

The declared return value.

oa::Status oa::Navigation::keyboardZoomTo100()

No public source comment is attached to this declaration.

Returns

oa::Status

The declared return value.

const oa::vlm::Vec3 & oa::Navigation::movement()

No public source comment is attached to this declaration.

Returns

const oa::vlm::Vec3 &

The declared return value.

oa::Status oa::Navigation::panBy(
	oa::F32 inDx,
	oa::F32 inDy
)

No public source comment is attached to this declaration.

Parameters

inDx

oa::F32

—

inDy

oa::F32

—

Returns

oa::Status

The declared return value.

oa::F32 oa::Navigation::panX()

No public source comment is attached to this declaration.

Returns

oa::F32

The declared return value.

oa::F32 oa::Navigation::panY()

No public source comment is attached to this declaration.

Returns

oa::F32

The declared return value.

void oa::Navigation::setCapturePointer(
	CaptureFn inFn
)

No public source comment is attached to this declaration.

Parameters

inFn

CaptureFn

—

Returns

void

The declared return value.

oa::Status oa::Navigation::setContentSize(
	oa::F32 inWidth,
	oa::F32 inHeight
)

No public source comment is attached to this declaration.

Parameters

inWidth

oa::F32

—

inHeight

oa::F32

—

Returns

oa::Status

The declared return value.

oa::Status oa::Navigation::setWindowSize(
	oa::F32 inWidth,
	oa::F32 inHeight
)

No public source comment is attached to this declaration.

Parameters

inWidth

oa::F32

—

inHeight

oa::F32

—

Returns

oa::Status

The declared return value.

oa::Status oa::Navigation::update(
	oa::F32 inDeltaMs
)

No public source comment is attached to this declaration.

Parameters

inDeltaMs

oa::F32

—

Returns

oa::Status

The declared return value.

oa::Status oa::Navigation::validate()

Configuration and direct mutations are result-bearing. Rejected input never changes the current navigation state.

Returns

oa::Status

The declared return value.

oa::F32 oa::Navigation::zoom()

No public source comment is attached to this declaration.

Returns

oa::F32

The declared return value.

oa::Status oa::Navigation::zoomTo(
	oa::F32 inZoom,
	oa::F32 inAnchorX,
	oa::F32 inAnchorY,
	bool inAnimate = true
)

No public source comment is attached to this declaration.

Parameters

inZoom

oa::F32

—

inAnchorX

oa::F32

—

inAnchorY

oa::F32

—

inAnimate

bool

Default: true

Returns

oa::Status

The declared return value.