The HShellObject class is a simple wrapper for a shell.
More...
#include <HUtility.h>
The HShellObject class is a simple wrapper for a shell.
HShellObject allows you to easily get about a shell's properties like faces and regions.
| HShellObject::HShellObject |
( |
HC_KEY |
kShellKey | ) |
|
Constructs an HShellObject from a given key.
- Parameters
-
| kshellKey | Pass the key you want to get shell information from. |
| int HShellObject::GetFaceCount |
( |
| ) |
const |
- Returns
- The number of faces in the shell.
| int HShellObject::GetFaceFlistIndex |
( |
int |
index | ) |
const |
This method return the index into the face list given a face number.
- Parameters
-
| index | The face number you wish to get information about. |
- Returns
- The index into the face list for the given face number.
| int const* HShellObject::GetFlist |
( |
| ) |
const |
- Returns
- A pointer to the face list.
| void HShellObject::GetFlist |
( |
int |
flist[] | ) |
const |
- Parameters
-
| An | array of ints (returned to the user) representing the face list. Note that the caller must ensure that the array is of the appropriate size, e.g, via the GetFlistLen function |
| int HShellObject::GetFlistLen |
( |
| ) |
const |
- Returns
- The length of the face list.
| HC_KEY HShellObject::GetKey |
( |
| ) |
const |
| HShellRegion const HShellObject::GetRegion |
( |
int const |
index | ) |
const |
This method returns an HShellRegion given an index.
- Parameters
-
| index | Pass the index number of the region you want to examine. |
- Returns
- An HShellRegion associated with the passed index.
The documentation for this class was generated from the following file: