Facebook Twitter YouTube

class BoxShaftEffectObject

Defined in:  TSShafts.h
The BoxShaftEffectObject class encapsulates data pertaining to a box light shaft effect.
Definition

class BoxShaftEffectObject final : public ShaftEffectObject, public BoxVolume

Constructor

BoxShaftEffectObject(const Vector3D& size, const ColorRGBA& color);

Parameters
size The size of the light shaft's cross section in the x and y components, and the height of the light shaft in the z component.
color The color of the light shaft.
Description
The BoxShaftEffectObject class encapsulates data pertaining to a box light shaft effect. In its local coordinate space, the rectangular cross section of a box light shaft has one of its corners at the origin, and the components of the size parameter define the extents of the rectangle in the positive x and y directions. The height parameter defines the extent of the light shaft in the z direction, but this is only used for constructing the polygonal geometry of the light shaft. The interior of the light shaft itself is rendered as if it had infinite extent in the z direction.
Base Classes
ShaftEffectObject A BoxShaftEffectObject is an object that can be shared by multiple box light shaft effect nodes.
BoxVolume A BoxShaftEffectObject is represented by a generic box volume.
See Also

BoxShaftEffect