class MarkingEffect

Defined in: C4Effects.h

The MarkingEffect class represents a surface marking node in a world.

Definition

class MarkingEffect : public Effect, public ListElement<MarkingEffect>, public Memory<MarkingEffect>

Member Functions

`MarkingEffect::New`	Creates a set of marking effects at a particular location.
`MarkingEffect::Nonempty`	Returns a boolean value indicating whether a surface marking contains any triangles.

Constructor

MarkingEffect(const Geometry *geometry, const MarkingData *data);

Parameters

`geometry`	The geometry to which the marking is to be applied.
`data`	A pointer to a `MarkingData` data structure defining the marking's parameters.

Description

The MarkingEffect class represents a surface marking node that is associated with a single geometry node.

Surface markings are normally generated for all of the geometries intersecting a particular location by calling the MarkingEffect::New function, but it is also possible to construct a MarkingEffect directly. If the MarkingEffect constructor is explicitly called (by using the new operator), then the calling code should subsequently call the MarkingEffect::Nonempty function to determine whether any triangles were generated. If the marking effect is not empty, then it should be added to the scene as a subnode of the geometry node specified by the geometry parameter by calling the Node::AddNewSubnode function. If the MarkingEffect::Nonempty function returns false, then the marking effect should simply be deleted.

Base Classes

`Effect`	A `MarkingEffect` node is a specific type of `Effect`.
`ListElement<MarkingEffect>`	Each `MarkingEffect` node belonging to a single surface marking can be stored in a `MarkingList` object.
`Memory<MarkingEffect>`	Storage for marking effects is allocated in a dedicated heap for speed.