C4 Engine
C4 Engine API Documentation

class ShaftEffectObject

Defined in:  C4Shafts.h
The ShaftEffectObject class encapsulates data pertaining to a light shaft effect.
Definition

class ShaftEffectObject : public EffectObject, public VolumeObject

Constructor

ShaftEffectObject(ShaftType type, const Vector2D& size, float height, const ColorRGBA& color);

Parameters
type The type of the light shaft effect.
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 ShaftEffectObject class is the base class for all types of shaft effect objects, and it stores data that is common to all of them. Each specific type of shaft effect has an associated object that is a subclass of the ShaftEffectObject class.
Base Classes
EffectObject A ShaftEffectObject is an object that can be shared by multiple shaft effect nodes.
VolumeObject Used internally by the engine for generic volume objects.
See Also

ShaftEffect

Wiki Articles

Shaft Effects