This reference page is linked to from the following overview topics: Pipeline Overview, Hit Testing, Sub-Object Hit Testing, Sub-Object Selection in Edit Modifiers.
Detailed Description
The ModContext stores information about the space the modifier was applied in, and allows the modifier to store data is needs for its operation.
All methods are implemented by the system.
- See also:
- class LocalModData
#include <object.h>
Public Member Functions |
|
| CoreExport | ~ModContext () |
| Destructor. |
|
| CoreExport | ModContext () |
| Constructor. |
|
| CoreExport | ModContext (const ModContext &mc) |
| Constructor. |
|
| CoreExport | ModContext (Matrix3 *tm, Box3 *box, LocalModData *localData) |
| Constructor. |
|
Public Attributes |
|
| Matrix3 * | tm |
| This matrix represents the space the
modifier was applied in. |
|
| Box3 * | box |
| The Bounding Box of the Deformation.
|
|
| LocalModData * | localData |
| A pointer to an instance of a class derived
from the LocalModData
class. |
|
Constructor & Destructor Documentation
| CoreExport ~ModContext | ( | ) |
Destructor.
The tm, bounding box and local data are freed.
| CoreExport ModContext | ( | ) |
Constructor.
The transformation matrix, bounding box, and local data pointer are initialized to NULL.
| CoreExport ModContext | ( | const ModContext & | mc | ) |
Constructor.
The tm, bounding box and local data are initialized to those of the specified ModContext.
- Parameters:
-
mc The ModContext to copy.
| CoreExport ModContext | ( | Matrix3 * | tm, |
| Box3 * | box, | ||
| LocalModData * | localData | ||
| ) |
Constructor.
The tm, bounding box, and local data are initialized to those specified.
- Parameters:
-
tm The transform matrix to copy. box The bounding box to copy. localData The local data that will be cloned.
Member Data Documentation
This matrix represents the space the modifier was applied in.
The modifier plug-in uses this matrix when it deforms an object. The plug-in first transforms the points with this matrix. Next it applies its own deformation. Then it transforms the points back through the inverse of this transformation matrix.
The Bounding Box of the Deformation.
This represents the scale of the modifier. For a single object it is the bounding box of the object. If the modifier is being applied to a sub-object selection it represents the bounding box of the sub-object selection. If the modifier is being applied to a selection set of objects, then this is the bounding box of the entire selection set. For a selection set of objects the bounding box is constant. In the case of a single object, the bounding box is not constant.
A pointer to an instance of a class derived from the LocalModData class.
This is the part of the ModContext that the plug-in developer controls. It is the place where a modifier may store application specific data.
