ARViewPort Class Reference

Public Member Functions
	ARViewPort ()
	ARViewPort (int offsetX, int offsetY, int width, int height)
void	setCamera (ARCamera camera)
int	getOffsetX ()
int	getOffsetY ()
int	getWidth ()
int	getHeight ()
void	setViewportParms (int offsetX, int offsetY, int width, int height)
ARCamera	getCamera ()
void	setZOrder (int zOrder)
int	getZOrder ()

Detailed Description

ARViewPort represents a viewport into the scene. It can be used for cropping the rendered image or for zoom.

Constructor & Destructor Documentation

ARViewPort ( )

inline

Initialises the ARViewPort.

ARViewPort ( int  offsetX, int  offsetY, int  width, int  height  )

inline

Initialises an instance of an ARViewPort with the given X and Y offset values and the given height and width values.

Parameters

offsetX	Bottom left x coordinate.
offsetY	Bottom left y coordinate.
height	Viewport height.
width	Viewport width.

Member Function Documentation

ARCamera getCamera ( )

inline

Returns the ARViewPorts ARCamera.

Returns

ARCamera

int getHeight ( )

inline

Returns the height of the viewport, in pixels, including any that extend beyond edge of the screen.

Returns

The height of the viewport in pixels.

int getOffsetX ( )

inline

Returns the offset of the viewport in the X direction. This can be negative to crop horizontally.

Returns

The offset of the viewport in the X direction.

int getOffsetY ( )

inline

Returns the offset of the viewport in the Y direction. This can be negative to crop vertically.

Returns

The offset of the viewport in the Y direction.

int getWidth ( )

inline

Returns the width of the viewport, in pixels, including any that extend beyond edge of the screen.

Returns

The width of the viewport.

int getZOrder ( )

inline

Gets the value determining the order when there are multiple viewports added to a render target. Lower values get rendered first. Negative integers are OK.

Returns

The order of this viewport.

void setCamera ( ARCamera  camera )

inline

Sets the ARViewPort's ARCamera. This acts as the root of the viewport's scene graph.

Parameters

camera

ARCamera to use

void setViewportParms ( int  offsetX, int  offsetY, int  width, int  height  )

inline

Sets ARViewport's parameters.

Parameters

offsetX	Bottom left x coordinate.
offsetY	Bottom left y coordinate.
height	Viewport height.
width	Viewport width.

void setZOrder ( int  zOrder )

inline

When there are multiple viewports added to a render target, this value determines the order. Lower values get rendered first. Negative integers are OK.

Parameters

zOrder

---

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

• ARViewPort.java