ARLight Class Reference

#import <ARLight.h>

Inherits ARNode.

Inherited by ARDirectionalLight, and ARPointLight.

Instance Methods
(instancetype)	- initWithColour:
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:

Properties
ARVector3 *	colour
float	ambientCoefficient
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
Class Methods inherited from ARNode
(instancetype)	+ nodeWithName:
Protected Types inherited from ARNode
enum	TransformSpace { ARNodeTransformSpaceLocal, ARNodeTransformSpaceParent, ARNodeTransformSpaceWorld }

Detailed Description

The base light class from which all light classes derive. If an ARLight is used, it will behave like a point light, but it will not have any attenuation, so the light will not fade over distance.

Example of use:

ARNode *node = [[ARNode alloc] init];
ARLight *light = [[ARLight alloc] initWithColour:[ARVector3 vectorWithValuesX:0.1 Y:0.2 Z:0.3];
[node addChild:light];
light.position = [ARVector3 vectorWithValuesX:0.0 Y:0.0 Z:0.0];
light.ambientCoefficient = 0.5;

Method Documentation

initWithColour:

- (id) initWithColour:

(ARVector3 *)

colour

Initialises an instance of ARLight using the given RGB values in the form of an ARVector3.

Example of use:

ARLight *light = [[ARLight alloc] initWithColour:[ARVector3 vectorWithValuesX:0.3 Y:0.4 Z:0.5];

Parameters

colour

ARVector3 which holds R,G,B values of 0..1

Property Documentation

ambientCoefficient

- (float) ambientCoefficient

readwritenonatomicassign

The minimum amount of illumination added to all objects in the scene regardless of incident light.

colour

- (ARVector3*) colour

readwritenonatomicassign

An ARVector3 representing the colour component of this light. Each component (X, Y, Z) of this vector should be in the range 0..1.

---

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

• ARLight.h
• ARLight.m