visman::components::visman_core::Viewport

Overview

interface Viewport extends NamedEntity

A viewport defines a specific view area within the visualization. It controls position, size, anchor alignment and what image to use.

Operation Index

getAnchor: Returns the anchor point that determines how the viewport is aligned relative to its parent container.
setAnchor: Sets the anchor point used to align the viewport.
getSize: Returns the size of the viewport.
setSize: Sets the size of the viewport.
getOffset: Returns the positional offset of the viewport relative to its anchor.
setOffset: Sets the positional offset of the viewport relative to its anchor.
isVisible: Returns whether the viewport is currently visible.
setVisible: Sets the visibility state of the viewport.
getProvider: Returns the provider identifier used as source selector for this viewport.
setProvider: Sets the provider identifier used as source selector for this viewport.

Operations

AnchorPoint getAnchor()

Returns the anchor point that determines how the viewport is aligned relative to its parent container.

Return Value

The current AnchorPoint of the viewport.

void setAnchor(AnchorPoint newAnchor)

Sets the anchor point used to align the viewport.

Parameters

newAnchor: The new AnchorPoint to apply.

Vector2f getSize()

Returns the size of the viewport.

Return Value

A Vector2f describing width and height.

void setSize(Vector2f newSize)

Sets the size of the viewport.

Parameters

newSize: A Vector2f describing the new width and height.

Vector2f getOffset()

Returns the positional offset of the viewport relative to its anchor.

Return Value

A Vector2f describing the X/Y offset.

void setOffset(Vector2f newOffset)

Sets the positional offset of the viewport relative to its anchor.

Parameters

newOffset: A Vector2f describing the new X/Y offset.

bool isVisible()

Returns whether the viewport is currently visible.

Return Value

True if the viewport is visible, false otherwise.

void setVisible(bool visible)

Sets the visibility state of the viewport.

Parameters

visible: True to make the viewport visible, false to hide it.

string getProvider()

Returns the provider identifier used as source selector for this viewport. Typical values are image-provider names or ArViz focus-object identifiers.

Return Value

Provider identifier string.

void setProvider(string provider)

Sets the provider identifier used as source selector for this viewport.

Parameters

provider: Provider identifier string.