class CapsuleVolume

Defined in: C4Volumes.h

The CapsuleVolume class encapsulates data pertaining to a generic capsule volume.

Definition

class CapsuleVolume : public Volume

Member Functions

`CapsuleVolume::GetCapsuleSize`	Returns the hemispherical cap size.
`CapsuleVolume::SetCapsuleSize`	Sets the hemispherical cap size.
`CapsuleVolume::GetCapsuleHeight`	Returns the height of the cylindrical interior.
`CapsuleVolume::SetCapsuleHeight`	Sets the height of the cylindrical interior.

Constructor

CapsuleVolume(const Vector3D& size, float height);

Parameters

`size`	The size of the hemispherical caps.
`height`	The height of the cylindrical interior.

Description

The CapsuleVolume class encapsulates the physical dimensions of a generic capsule volume and functionality that is used by various subclasses throughout the engine.

The center of the base of the interior cylinder coincides with the origin, and the three components of the size parameter correspond to the radii of the hemispherical caps along the x, y, and z axes. The height parameter specifies the physical height of the cylindrical interior along the positive z axis.

Base Classes

Volume A CapsuleVolume is a generic volume.