MathEngine
Home Page       Structures       File List       Functions and Macros      

McdCylinder.h File Reference

The cylinder primitive geometry type. More...

#include "McdFrame.h"

Typedefs

typedef McdGeometryID McdCylinderID
 McdCylinder is a concrete McdGeometry type.


Functions

void McdCylinderRegisterType ()
 Register the McdCylinder geometry type with the Mcd system. More...

int McdCylinderGetTypeID ()
 Returns a unique ID identifying the McdCylinder geometry type.

McdCylinderID McdCylinderCreate ( McdReal r, McdReal h )
 Create a new cylinder geometry. More...

void McdCylinderSetRadius ( McdCylinderID g, McdReal r )
 Set the cylinder's radius. More...

void McdCylinderSetHeight ( McdCylinderID g, McdReal h )
 Set the cylinder's height. More...

McdReal McdCylinderGetRadius ( McdCylinderID g )
 Return the cylinder's radius. More...

McdReal McdCylinderGetHeight ( McdCylinderID g )
 Return the cylinder's height. More...


Detailed Description

The cylinder primitive geometry type.


Function Documentation

McdCylinderID McdCylinderCreate ( McdReal r,
McdReal h )

Create a new cylinder geometry.

Parameters:
r   : radius
h   : height

The axis of the cylinder is along the z-axis of its local coordinate system.

McdReal McdCylinderGetHeight ( McdCylinderID g )

Return the cylinder's height.

Parameters:
h   : height

McdReal McdCylinderGetRadius ( McdCylinderID g )

Return the cylinder's radius.

Parameters:
r   : radius

void McdCylinderRegisterType ( )

Register the McdCylinder geometry type with the Mcd system.

McdCylinder is often registered implicitly via McdPrimitivesRegisterTypes() or McdSphereBoxPlaneRegisterTypes(), in which case it is an error to call McdBoxRegisterType() explicitly as well.

void McdCylinderSetHeight ( McdCylinderID g,
McdReal h )

Set the cylinder's height.

Parameters:
h   : height

void McdCylinderSetRadius ( McdCylinderID g,
McdReal r )

Set the cylinder's radius.

Parameters:
r   : radius

MathEngine Collision Toolkit - Version 0.0.5 Alpha - Reference Manual generated using doxygen at Wed Oct 11 00:34:40 2000

Copyright MathEngine PLC 2000, all rights reserved.