This reference page is linked to from the following overview topics: SDK Change Details.
Detailed Description
The Named Selection Sets management class.
The user may use functions exposed by this class to manage all the named selection sets of objects.
- Note:
- This class DOES NOT deal with named selection sets of sub-objects but only named selection sets of objects.
#include <INamedSelectionSetManager.h>
Public Member Functions |
|
| virtual int | GetNumNamedSelSets () const =0 |
| Get the count of all the named selection
sets. |
|
|
Named Selection Set functions.
|
|
|
The following functions deal with a specific named selection set. |
|
| virtual MCHAR * | GetNamedSelSetName (int setNum) const =0 |
| Get the name of the named selection set
whose index is passed. |
|
| virtual BOOL | AddNewNamedSelSet (Tab< INode * > &nodes, MSTR &name)=0 |
| Adds a new named selection set to those
already available in the drop down list in the MAX toolbar.
|
|
| virtual BOOL | RemoveNamedSelSet (MSTR &name)=0 |
| Removes the specified named selection set
those already available in the drop down list in the MAX toolbar.
|
|
| virtual BOOL | RemoveNamedSelSet (int setNum)=0 |
| Removes the specified named selection set
those already available in the drop down list in the MAX toolbar.
|
|
| virtual BOOL | GetNamedSelSetList (Tab< INode * > &nodes, int setNum) const =0 |
| Get a specified named selection set by its
index. |
|
| virtual BOOL | SetNamedSelSetName (int setNum, MSTR &name)=0 |
| Sets node named selection set's name.
Returns TRUE if successful. |
|
|
Named Selection Set items functions.
|
|
|
The following functions deal with items of a specific named selection set. |
|
| virtual int | GetNamedSelSetItemCount (int setNum) const =0 |
| Get the number of items in the named
selection set whose index is passed. |
|
| virtual INode * | GetNamedSelSetItem (int setNum, int i) const =0 |
| Get the specified node of a specified named
selection set. |
|
| virtual BOOL | ReplaceNamedSelSet (Tab< INode * > &nodes, int setNum)=0 |
| Replace the specified named selection set
with given nodes. |
|
| virtual BOOL | ReplaceNamedSelSet (Tab< INode * > &nodes, MSTR &name)=0 |
| Replace the specified named selection set
with given nodes. |
|
Static Public Member Functions |
|
| static INamedSelectionSetManager * | GetInstance () |
| Get the instance of INamedSelectionSetManager.
|
|
Member Function Documentation
| static INamedSelectionSetManager* GetInstance | ( | ) | [inline, static] |
Get the instance of INamedSelectionSetManager.
- Returns:
- the instance of INamedSelectionSetManager.
{
return static_cast<INamedSelectionSetManager*>(
GetCOREInterface(IID_NAMED_SELECTION_SET_MANAGER));
}
| virtual int GetNumNamedSelSets | ( | ) | const [pure virtual] |
Get the count of all the named selection sets.
- Returns:
- the count of all the named selection sets.
| virtual MCHAR* GetNamedSelSetName | ( | int | setNum | ) | const [pure virtual] |
Get the name of the named selection set whose index is passed.
- Parameters:
-
[in] setNum - The index of the named selection set.
- Returns:
- the name of the named selection set if the given index is valid, NULL otherwise.
Adds a new named selection set to those already available in the drop down list in the MAX toolbar.
- Parameters:
-
[in] nodes - The table of nodes making up the selection set. [in] name - The name for the set.
- Returns:
- TRUE if the named selection set is successfully added,FALSE otherwise.
| virtual BOOL RemoveNamedSelSet | ( | MSTR & | name | ) | [pure virtual] |
Removes the specified named selection set those already available in the drop down list in the MAX toolbar.
- Parameters:
-
[in] name - The name for the set to remove.
- Returns:
- TRUE if the named selection set is successfully removed,FALSE otherwise.
| virtual BOOL RemoveNamedSelSet | ( | int | setNum | ) | [pure virtual] |
Removes the specified named selection set those already available in the drop down list in the MAX toolbar.
- Parameters:
-
[in] setNum - The index of the specified named selection set.
- Returns:
- TRUE if the named selection set is successfully removed,FALSE otherwise.
Get a specified named selection set by its index.
- Parameters:
-
[out] nodes - The node set of the specified named selection set that is to be fatched.This node set will be filled only if the specified index is valid. [in] setNum - The index of the specified named selection set. If the index is invalid, an empty nodes set is to be returned.
- Returns:
- TRUE if the specified named set index is valid,FALSE otherwise.
| virtual BOOL SetNamedSelSetName | ( | int | setNum, |
| MSTR & | name | ||
| ) | [pure virtual] |
Sets node named selection set's name. Returns TRUE if successful.
- Parameters:
-
[in] setNum - The selection set index. [in] name - The new name for the selection set.
- Returns:
- TRUE if the specified named selection set is found with its name set, FALSE otherwise.
| virtual int GetNamedSelSetItemCount | ( | int | setNum | ) | const [pure virtual] |
Get the number of items in the named selection set whose index is passed.
- Parameters:
-
[in] setNum The index of the named selection set.
- Returns:
- the number of items in the named selection set if the given index is valid, 0 otherwise.
| virtual INode* GetNamedSelSetItem | ( | int | setNum, |
| int | i | ||
| ) | const [pure virtual] |
Get the specified node of a specified named selection set.
This method may be used to retrieve the INode pointer of the 'i-th' item in the named selection set whose index is passed.
- Parameters:
-
[in] setNum - The index of the selection set whose 'i-th' INode pointer is returned. [in] i - The index into the selection set.
- Returns:
- the specified node if the given set index and node index is valid, NULL otherwise.
Replace the specified named selection set with given nodes.
- Parameters:
-
[in] nodes - The given nodes to be filled into the named selection set. [in] setNum - The index of the specified named selection set.
- Returns:
- TRUE if the specified selection set is found and replaced, FALSE otherwise.
Replace the specified named selection set with given nodes.
- Parameters:
-
[in] nodes - The given nodes to be filled into the named selection set. [in] name - The name of the specified named selection set.
- Returns:
- TRUE if the specified selection set is found and replaced, FALSE otherwise.
