class FieldObject

Defined in: C4Fields.h

The FieldObject class encapsulates data pertaining to a field volume.

Definition

class FieldObject : public Object, public VolumeObject

Member Functions

`FieldObject::GetFieldType`	Returns the specific type of a field.
`FieldObject::GetFieldFlags`	Returns the field flags.
`FieldObject::SetFieldFlags`	Sets the field flags.

Constructor

FieldObject(FieldType type, Volume *volume);

The constructor has protected access. The FieldObject class can only exist as the base class for another class.

Parameters

`type`	The type of the field volume. See below for a list of possible types.
`volume`	A pointer to the generic volume object representing the field.

Description

The FieldObject class encapsulates data describing a volume used for force fields in a physics simulation.

A field object can be of one of the following types.

`kFieldBox`	A box field.
`kFieldCylinder`	A cylinder field.
`kFieldSphere`	A sphere field.

Base Classes

`Object`	A `FieldObject` is an object that can be shared by multiple field nodes.
`VolumeObject`	Used internally by the engine for generic volume objects.