This reference page is linked to from the following overview topics: Deferred Loading of Plug-ins.
Detailed Description
The interface to the geometry checker manager.
This manager is responsible for registering, activitating and displaying the results of the geometry checkers. You get this interface by calling GetIGeometryCheckerManager()
#include <IGeometryChecker.h>
Public Member Functions |
|
| virtual IGeometryChecker * | GetNthGeometryChecker (int index) const =0 |
| Get the nth GeometryChecker. |
|
| virtual MSTR | GetNthGeometryCheckerName (int index) const =0 |
| Get the name of the nth Geometry Checker.
|
|
| virtual bool | ActivateGeometryChecker (int index)=0 |
| Activate this geometry checker so that it is
the one that's run. |
|
| virtual int | GetActivatedGeometryCheckerIndex () const =0 |
| Returns the index of the activated geometry
checker. |
|
| virtual bool | DoesGeometryCheckerHavePropDlg (int index) const =0 |
| Get whether or not the specified geometry
checker has a property dialog. |
|
| virtual void | ShowGeometryCheckerPropDlg (int index)=0 |
| Show the specified geometry checkers dialog.
|
|
| virtual void | RunGeometryCheck (TimeValue t)=0 |
| Run the current geometry check based upon
the active geometry checker and the current selection set. |
|
| virtual IGeometryChecker::ReturnVal | GeometryCheck (TimeValue t, INode *node, IGeometryChecker::OutputVal &val)=0 |
| Run the active geometry checker at this time
and on this node. |
|
| virtual void | PopupMenuSelect ()=0 |
| Show the selection popup menu that lets you
pick different checkers to be active and modify different geometry
checker manager properties. |
|
| virtual void | SelectResults (TimeValue t)=0 |
| Select the results of the currently run
geometry check on the currently selected node. |
|
| virtual void | DisplayResults (Color *overrideColor, TimeValue t, INode *node, HWND hwnd, IGeometryChecker::ReturnVal type, Tab< int > &indices)=0 |
| Utility function to use the internal display
mechanism to display a set of highlighted vertices, edges or faces.
|
|
| virtual DWORD | GetNextValidGeometryCheckerID ()=0 |
| Utility function to get the next valid
geometry checker id. |
|
|
Registeration Functions
|
|
| virtual int | RegisterGeometryChecker (IGeometryChecker *geomChecker)=0 |
| Register the geometry checker. |
|
| virtual void | UnRegisterGeometryChecker (IGeometryChecker *geomChecker)=0 |
| Unregister a geometry checker. |
|
| virtual int | GetNumRegisteredGeometryCheckers () const =0 |
| Returns the number of registered geometry
checkers. |
|
|
Properties
|
|
| virtual void | SetGeometryCheckerOn (bool on)=0 |
| Set whether or not the geometry checker
system is on so checks will be run and outupt displayed. |
|
| virtual bool | GetGeometryCheckerOn () const =0 |
| Returns whether or not the geometry checker
system is on. |
|
| virtual void | SetSeeThrough (bool val)=0 |
| Set whether or not the results can be seen
through objects or not. |
|
| virtual bool | GetSeeThrough () const =0 |
| Get whether or not the results should be
seen through objects or not. |
|
| virtual void | SetAutoUpdate (bool val)=0 |
| Turn on or off the automatic updating of the
geometry checker. |
|
| virtual bool | GetAutoUpdate () const =0 |
| Returns true if automatic updating of the
geometry checker is on and false if not. |
|
| virtual void | SetDisplayTextUpTop (bool val)=0 |
| Set the output display text on the top or
bottom of the viewport. |
|
| virtual bool | GetDisplayTextUpTop () const =0 |
| Returns true if the text is displayed on top
of the viewport, false if displayed on the bottom. |
|
|
Getting the Current Output
|
|
| virtual IGeometryChecker::ReturnVal | GetCurrentReturnVal ()=0 |
| Gets the current ReturnVal of the current
geometry check. |
|
| virtual int | GetCurrentOutputCount ()=0 |
| Gets the number of indices in the current
output. |
|
| virtual MSTR | GetCurrentString ()=0 |
| Returns the output string that's shown as
text display. |
|
Member Function Documentation
| virtual int RegisterGeometryChecker | ( | IGeometryChecker * | geomChecker | ) | [pure virtual] |
Register the geometry checker.
- Parameters:
-
[in] geomChecker The checker to be registered.
- Returns:
- Returns the index of the checker among the other registered checkers. A value of -1 means an error occured.
| virtual void UnRegisterGeometryChecker | ( | IGeometryChecker * | geomChecker | ) | [pure virtual] |
Unregister a geometry checker.
- Parameters:
-
[in] geomChecker The checker you want to unregister.
| virtual int GetNumRegisteredGeometryCheckers | ( | ) | const [pure virtual] |
Returns the number of registered geometry checkers.
| virtual void SetGeometryCheckerOn | ( | bool | on | ) | [pure virtual] |
Set whether or not the geometry checker system is on so checks will be run and outupt displayed.
- Parameters:
-
[in] on If true the geometry checker system is on, if false it's off and no output or checks occur.
| virtual bool GetGeometryCheckerOn | ( | ) | const [pure virtual] |
Returns whether or not the geometry checker system is on.
| virtual void SetSeeThrough | ( | bool | val | ) | [pure virtual] |
Set whether or not the results can be seen through objects or not.
- Parameters:
-
[in] val If true the results can be seen through other objects, if false, they can't. In other words if the value is true we disable z depth testing when drawing the results.
| virtual bool GetSeeThrough | ( | ) | const [pure virtual] |
Get whether or not the results should be seen through objects or not.
- Returns:
- Return true if the results can be seen through objects, false if not.
| virtual void SetAutoUpdate | ( | bool | val | ) | [pure virtual] |
Turn on or off the automatic updating of the geometry checker.
If it's on, then the geometry checker will run whenever a new object is selected or some change happens to the model. If false the user needs to manual run and update the checker, which is useful for tests which are slow.
| virtual bool GetAutoUpdate | ( | ) | const [pure virtual] |
Returns true if automatic updating of the geometry checker is on and false if not.
| virtual void SetDisplayTextUpTop | ( | bool | val | ) | [pure virtual] |
Set the output display text on the top or bottom of the viewport.
- Parameters:
-
[in] val If true the text is displayed on top, if false, it's displayed on the bottom.
| virtual bool GetDisplayTextUpTop | ( | ) | const [pure virtual] |
Returns true if the text is displayed on top of the viewport, false if displayed on the bottom.
| virtual IGeometryChecker* GetNthGeometryChecker | ( | int | index | ) | const [pure virtual] |
Get the nth GeometryChecker.
- Parameters:
-
[in] index The index of the registered geoemtry checker
- Returns:
- Returns the geometry checker at that index
| virtual MSTR GetNthGeometryCheckerName | ( | int | index | ) | const [pure virtual] |
Get the name of the nth Geometry Checker.
- Parameters:
-
[in] index The index of the registered geoemtry checker
- Returns:
- The name of the geometry checker at that index
| virtual bool ActivateGeometryChecker | ( | int | index | ) | [pure virtual] |
Activate this geometry checker so that it is the one that's run.
- Parameters:
-
[in] index The index of the geometry checker that's being made active.
- Returns:
- Returns true if the function correctly sets that checker active, false otherwise.
| virtual int GetActivatedGeometryCheckerIndex | ( | ) | const [pure virtual] |
Returns the index of the activated geometry checker.
| virtual bool DoesGeometryCheckerHavePropDlg | ( | int | index | ) | const [pure virtual] |
Get whether or not the specified geometry checker has a property dialog.
- Parameters:
-
[in] index The index which to check to see if the geometry checker has a dialog.
- Returns:
- Returns true if that geometry checker has a property dialog, false otherwise.
| virtual void ShowGeometryCheckerPropDlg | ( | int | index | ) | [pure virtual] |
Show the specified geometry checkers dialog.
- Parameters:
-
[in] index The index of the geometry checker that will show it's property dialog.
| virtual void RunGeometryCheck | ( | TimeValue | t | ) | [pure virtual] |
Run the current geometry check based upon the active geometry checker and the current selection set.
- Parameters:
-
[in] t The time at which to run the check.
| virtual IGeometryChecker::ReturnVal GeometryCheck | ( | TimeValue | t, |
| INode * | node, | ||
| IGeometryChecker::OutputVal & | val | ||
| ) | [pure virtual] |
Run the active geometry checker at this time and on this node.
- Parameters:
-
[in] t The time at which to run the check. [in] node The node on which to run the check. [out] val The output of the check. Currently a list of indices.
- Returns:
- The ReturnVal of the geometry check. May be IGeometryChecker::eVertices, IGeometryChecker::eEdges, or IGeometryChecker::eFaces.
| virtual void PopupMenuSelect | ( | ) | [pure virtual] |
Show the selection popup menu that lets you pick different checkers to be active and modify different geometry checker manager properties.
| virtual IGeometryChecker::ReturnVal GetCurrentReturnVal | ( | ) | [pure virtual] |
Gets the current ReturnVal of the current geometry check.
| virtual int GetCurrentOutputCount | ( | ) | [pure virtual] |
Gets the number of indices in the current output.
| virtual MSTR GetCurrentString | ( | ) | [pure virtual] |
Returns the output string that's shown as text display.
| virtual void SelectResults | ( | TimeValue | t | ) | [pure virtual] |
Select the results of the currently run geometry check on the currently selected node.
Based upon the ReturnType it will select the correct vertices, edges or faces on that node, in the current active modifier or object.
- Parameters:
-
[in] t The time to perform the selection.
| virtual void DisplayResults | ( | Color * | overrideColor, |
| TimeValue | t, | ||
| INode * | node, | ||
| HWND | hwnd, | ||
| IGeometryChecker::ReturnVal | type, | ||
| Tab< int > & | indices | ||
| ) | [pure virtual] |
Utility function to use the internal display mechanism to display a set of highlighted vertices, edges or faces.
- Parameters:
-
[in] overrideColor The color that you want the items to be displayed in. [in] t The time you want the node to get queried at for display. [in] node The node over which the display will be drawn over. [in] type The type of geometric item that will get displayed, may be IGeometryChecker::eVertices, IGeometryChecker::eEdges, or IGeometryChecker::eFaces [in] indices The indices of the geometric elements that will get highlighted.
| virtual DWORD GetNextValidGeometryCheckerID | ( | ) | [pure virtual] |
Utility function to get the next valid geometry checker id.
New geometry checkers should use this function to get an id.
- Returns:
- returns a valid geometry checker ID.
