C4 Engine
C4 Engine API Documentation

class SpotLightObject

Defined in:  C4LightObjects.h
The SpotLightObject class encapsulates data pertaining to a spot light source having a projected 2D texture map.
Definition

class SpotLightObject final : public ProjectionLightObject

Member Functions
SpotLightObject::GetApexTangent Returns the tangent of half the apex angle for a spot light.
SpotLightObject::SetApexTangent Sets the tangent of half the apex angle for a spot light.
Constructor

SpotLightObject(const ColorRGB& color, float range, float apex, const char *name);

Parameters
color The color of light emitted by the light source.
range The spherical range of the light source.
apex The tangent of half the apex angle for the spot light. This determines the light's angle of illumination.
name The name of the projected texture map.
Description
A spot light source is a special type of point light that projects a 2D texture onto the world in one direction. The SpotLightObject class contains information specific to the spot light type.
Base Classes
ProjectionLightObject A SpotLightObject is a specific type of projection light object.
See Also

SpotLight