ARViewPort Class Reference

#import <ARViewPort.h>

Inheritance diagram for ARViewPort:

Collaboration diagram for ARViewPort:

Instance Methods
(instancetype)	- initWithOffsetX:y:height:width:

Properties
float	offsetX
float	offsetY
float	width
float	height
ARCamera *	camera
ARRenderTarget *	renderTarget
int	zOrder

Detailed Description

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

Method Documentation

- (instancetype) initWithOffsetX:		(float)	x
y:		(float)	y
height:		(float)	height
width:		(float)	width

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

Example of use:

ARViewPort *viewPort = [[ARViewPort alloc] initWithOffsetX:0 y:0 height:self.view.frame.size.height width:self.view.frame.size.width];

Parameters

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

Property Documentation

- (ARCamera*) camera

readwritenonatomicassign

The ARViewPorts camera. This acts as the root of the viewports scene graph.

- (float) height

readwritenonatomicassign

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

- (float) offsetX

readwritenonatomicassign

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

- (float) offsetY

readwritenonatomicassign

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

- (ARRenderTarget*) renderTarget

readwritenonatomicweak

The ARRenderTarget that this viewport belongs to.

- (float) width

readwritenonatomicassign

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

- (int) zOrder

readwritenonatomicassign

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

---

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

• ARViewPort.h