Facebook Twitter YouTube

class CylinderShaftEffectObject

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

class CylinderShaftEffectObject final : public ShaftEffectObject, public CylinderVolume

Constructor

CylinderShaftEffectObject(const Vector2D& size, float height, const ColorRGBA& color);

Parameters
size The size of the light shaft's cross section.
height The height of the light shaft.
color The color of the light shaft.
Description
The CylinderShaftEffectObject class encapsulates data pertaining to a cylinder light shaft effect. In its local coordinate space, the elliptical cross section of a cylinder light shaft has its center at the origin, and the components of the size parameter define the semiaxis lengths 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 CylinderShaftEffectObject is an object that can be shared by multiple cylinder light shaft effect nodes.
CylinderVolume A CylinderShaftEffectObject is represented by a generic cylinder volume.
See Also

CylinderShaftEffect