AlBoxLight

Alias Programmers’ Interfaces (API) > Class reference > AlAction – AlBoxLight >

AlBoxLight

A class used to reference a box light.

Synopsis

#include <AlBoxLight.h>

class AlBoxLight: public AlVolumeLight

AlBoxLight();

virtual	~AlBoxLight();

statusCode	create();

virtual AlObject*	copyWrapper() const;

AlObjectType	type() const;

Description

A box light is a volume light where light exists within a cube. There are no additional parameters other than those already on the volume light.

A box light could be np-scaled and used to fill a room with light. If it is used as a force field, it could fill the room with turbulence, leaving the air outside the room still.

AlBoxLight::AlBoxLight()

Description

Constructs an AlBoxLight wrapper object.

AlBoxLight::~AlBoxLight()

Description

Deletes an AlBoxLight wrapper object.

statusCode AlBoxLight::create()

Description

Creates all the DAG nodes for this light and adds them to the universe. The DAG nodes are for ’position’, ’look at’ and ’up’, and another DAG node that groups these three together.

Return Codes

sSuccess - everything was successful

sInsufficientMemory - not enough memory available

sAlreadyCreated - light is already created

AlObjectType AlBoxLight::type() const

Description

Returns the class identifier kBoxLightType.