ARBillboardNode Class Reference

#import <ARBillboardNode.h>

Inherits ARNode.

Properties
ARVector3 *	forward
BOOL	lockX
BOOL	lockY
BOOL	lockZ
Properties inherited from ARNode
NSString *	name
ARNode *	parent
NSArray< ARNode * > *	children
NSArray *	descendants
ARVector3 *	position
ARVector3 *	scale
ARQuaternion *	orientation
ARMatrix4 *	localTransform
ARMatrix4 *	worldTransform
ARMatrix4 *	fullTransform
ARQuaternion *	fullOrientation
ARQuaternion *	worldOrientation
ARVector3 *	worldScale
ARVector3 *	worldPosition
ARVector3 *	fullPosition
ARNode *	world
NSUInteger	childCount
BOOL	visible

Additional Inherited Members
Instance Methods inherited from ARNode
(void)	- addChild:
(void)	- addChildren:
(void)	- removeChild:
(void)	- removeAllChildren
(void)	- remove
(ARNode *)	- findChildWithName:
(void)	- markWorldTransformAsDirty
(void)	- translateByX:y:z:
(void)	- translateByX:y:z:transformSpace:
(void)	- translateByVector:
(void)	- translateByVector:transformSpace:
(void)	- scaleByUniform:
(void)	- scaleByX:y:z:
(void)	- scaleByVector:
(void)	- rotateByDegrees:axisX:y:z:
(void)	- rotateByRadians:axisX:y:z:
(void)	- rotateByQuaternion:
(ARVector3 *)	- positionToWorld:
(ARVector3 *)	- positionToEye:
(ARQuaternion *)	- orientationToWorld:
(ARQuaternion *)	- orientationToEye:
(CGPoint)	- viewPortFromNodePosition:
(void)	- render
(void)	- preRender
(void)	- postRender
(void)	- addTouchTarget:withAction:
(void)	- didReceiveTouch
(ARVector3 *)	- nodeFromViewPort:
Class Methods inherited from ARNode
(instancetype)	+ nodeWithName:
Protected Types inherited from ARNode
enum	TransformSpace { ARNodeTransformSpaceLocal, ARNodeTransformSpaceParent, ARNodeTransformSpaceWorld }

Detailed Description

An ARBillboardNode is a subclass of ARNode that changes its orientation to ensure it always maintains its given forward vector direction relative to the camera. This is useful for showing content that rotates and follows the device as it moves around the scene and is especially useful for videos or other 2D content, as it will always be visible.

ARBillboardNodes can be used in conjunction with ArbiTrack to make 3D models or videos turn to follow the camera, or with the Image Tracker to have objects face the camera independently of the marker's orientation.

Property Documentation

forward

- (ARVector3*) forward

readwritenonatomicassign

The vector that should be aimed at the camera. For example, a vector of (0, 1, 0) would cause the Y-axis of the node's local space to point towards the camera.

lockX

- (BOOL) lockX

readwritenonatomicassign

Determines whether rotation around the X axis is locked. Default is NO.

lockY

- (BOOL) lockY

readwritenonatomicassign

Determines whether rotation around the Y axis is locked. Default is NO.

lockZ

- (BOOL) lockZ

readwritenonatomicassign

Determines whether rotation around the Z axis is locked. Default is NO.

---

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

• ARBillboardNode.h