Facebook Twitter YouTube

class TruncatedPyramidShaftEffectObject

Defined in:  TSShafts.h
The TruncatedPyramidShaftEffectObject class encapsulates data pertaining to a truncated pyramid light shaft effect.
Definition

class TruncatedPyramidShaftEffectObject final : public ShaftEffectObject, public TruncatedPyramidVolume

Constructor

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

Parameters
size The size of the light shaft's cross section at the base of the pyramid.
height The height of the light shaft.
ratio The ratio of the upper size to the base size.
color The color of the light shaft.
Description
The TruncatedPyramidShaftEffectObject class encapsulates data pertaining to a truncated pyramid light shaft effect. In its local coordinate space, the rectangular cross section of the base of a truncated pyramid 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 ratio parameter defines the ratio between the size of the top face and the bottom face (the base) of the truncated pyramid and should be in the range (0,1). The interior of the light shaft itself is rendered as if it extends to the apex of the untruncated pyramid in the z direction and as if it had infinite extent in the −z direction.
Base Classes
ShaftEffectObject A TruncatedPyramidShaftEffectObject is an object that can be shared by multiple truncated pyramid light shaft effect nodes.
TruncatedPyramidVolume A TruncatedPyramidShaftEffectObject is represented by a generic truncated pyramid volume.
See Also

TruncatedPyramidShaftEffect