class CylinderVolume

Defined in: C4Volumes.h

The CylinderVolume class encapsulates data pertaining to a generic cylinder volume.

Definition

class CylinderVolume : public Volume

Member Functions

`CylinderVolume::GetCylinderSize`	Returns the cylinder base size.
`CylinderVolume::SetCylinderSize`	Sets the cylinder base size.
`CylinderVolume::GetCylinderHeight`	Returns the cylinder height.
`CylinderVolume::SetCylinderHeight`	Sets the cylinder height.

Constructor

CylinderVolume(const Vector2D& size, float height);

The constructor has protected access. The CylinderVolume class can only exist as a base class for another class.

Parameters

`size`	The size of the cylinder base.
`height`	The height of the cylinder.

Description

The CylinderVolume class encapsulates the physical dimensions of a generic cylindrical 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 physical height of the cylinder along the positive z axis.

Base Classes

Volume A CylinderVolume is a generic volume.