C4 Engine
C4 Engine API Documentation

class TruncatedConeVolume

Defined in:  C4Volumes.h
The TruncatedConeVolume class encapsulates data pertaining to a generic cone volume.

class TruncatedConeVolume : public ConeVolume

Member Functions
TruncatedConeVolume::GetConeRatio Returns the truncated cone ratio.
TruncatedConeVolume::SetConeRatio Sets the truncated cone ratio.

TruncatedConeVolume(const Vector2D& size, float height, float ratio);

size The size of the cone base.
height The height of the truncated cone, measuring the distance between the top and bottom faces.
ratio The ratio of the dimensions of the top face to the dimensions of the bottom face.
The TruncatedConeVolume class encapsulates the physical dimensions of a generic truncated conical volume and functionality that is used by various subclasses throughout the engine.

The center of the base coincides with the origin, and the two components of the size parameter correspond to the radii along the x and y axes. The height parameter specifies the distance from the bottom face (the base) to the top face along the positive z axis. The ratio parameter specifies the ratio of the dimensions of the top face to the dimensions of the bottom face and should be in the range (0,1).
Base Classes
ConeVolume A TruncatedConeVolume is an extension of a cone volume.