# HShellObject

## Functions

| `HShellObject`
| `HShellObject`
| `~HShellObject`
HShellRegion const | `GetRegion`
int | `GetFaceCount`
int | `GetFaceFlistIndex`
HC_KEY | `GetKey`
int | `GetFlistLen`
int const * | `GetFlist`
void | `GetFlist`

## Detailed Description

class HShellObject

  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.

  Public Functions

  HShellObject(HC_KEY kShellKey)

    Constructs an HShellObject from a given key.

    Parameters

      kshellKey – Pass the key you want to get shell information from.

  HShellObject(HShellObject const &oShellObj)
  ~HShellObject()
  HShellRegion const 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.

  int GetFaceCount() const
    Returns

      The number of faces in the shell.

  int 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.

  HC_KEY GetKey() const
    Returns

      The key associated with this HShellObject.

  int GetFlistLen() const
    Returns

      The length of the face list.

  int const *GetFlist() const
    Returns

      A pointer to the face list.

  void 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