Adds
parameters for cylinder volume lights.
Synopsis
#include <AlCylinderLight.h>
class AlCylinderLight: public AlVolumeLight
AlCylinderLight();
virtual ~AlCylinderLight();
virtual AlObject* copyWrapper() const;
statusCode create();
AlObjectType type() const;
double arc() const;
statusCode setArc(double);
Description
A cylinder light creates
light within a cylinder.
AlCylinderLight::AlCylinderLight()
Description
Constructs
an AlCylinderLight wrapper object.
AlCylinderLight::~AlCylinderLight()
Description
Deletes
an AlCylinderLight wrapper object.
statusCode AlCylinderLight::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 - the DAG nodes
were created
sInsufficientMemory -
not enough memory available
sAlreadyCreated - the
light is already created
AlObjectType AlCylinderLight::type()
const
Description
Returns
the class identifier kCylinderLightType.
double AlCylinderLight::arc()
const
Description
Returns
the sphere light’s arc (that is, how much of the sphere we actually
have). This method returns -1 if the light is invalid.
statusCode AlCylinderLight::setArc(
double arc )
Description
Sets the arc of the light. The
given arc must be in the range 0 to 360.
Arguments
< double arc - portion
of the sphere to use
Return Codes
sSuccess - setting arc
succeeded
sInvalidObject - not
a valid volume light
sInvalidArgument - arc
out of the range 0..360
sFailure - an error occurred
