
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ShapeKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.ShapeKit in_kit) |
Check if the source ShapeKit is equivalent to this ShapeKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.ShapeKit in_kit) |
Copies the source ShapeKit into this ShapeKit. More... | |
HPS.ShapeKit | SetElement (HPS.ShapeElement in_element) |
Set a single element for this ShapeKit. This must be specified when defining a shape. More... | |
HPS.ShapeKit | SetElements (HPS.ShapeElement[] in_def) |
Sets the elements for this ShapeKit. This must be specified when defining a shape. More... | |
ShapeKit () | |
The default constructor creates an empty ShapeKit object. More... | |
ShapeKit (HPS.ShapeKit in_kit) | |
The copy constructor creates a new ShapeKit object that contains the same settings as the source ShapeKit. More... | |
void | Show (out HPS.ShapeKit out_kit) |
Copies this ShapeKit into the given ShapeKit. More... | |
bool | ShowElements (out HPS.ShapeElement[] out_def) |
Shows the elements for this ShapeKit. More... | |
HPS.ShapeKit | UnsetElements () |
Removes the elements for the shape. More... | |
HPS.ShapeKit | UnsetEverything () |
Removes all settings from this ShapeKit. More... | |
![]() | |
Kit (HPS.Kit in_that) | |
override HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Static Public Member Functions | |
static HPS.ShapeKit | GetDefault (HPS.Shape.Default in_default_shape) |
Creates a ShapeKit which contains the definition of the specified default shape. More... | |
static bool | operator!= (HPS.ShapeKit a, HPS.ShapeKit b) |
static bool | operator== (HPS.ShapeKit a, HPS.ShapeKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The ShapeKit class is a user space object. It is used for specifying all settings related to a ShapeDefinition.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty ShapeKit object.
|
inline |
Member Function Documentation
|
inlinevirtual |
Indicates whether this ShapeKit has any values set on it.
- Returns
- true if no values are set on this ShapeKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
|
inlinestatic |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Kit.
|
inline |
|
inline |
Set a single element for this ShapeKit. This must be specified when defining a shape.
- Parameters
-
in_element A reference to the ShapeElement to set on this kit.
- Returns
- A reference to this ShapeKit.
|
inline |
Sets the elements for this ShapeKit. This must be specified when defining a shape.
- Parameters
-
in_def The array of elements for the shape.
- Returns
- A reference to this ShapeKit.
|
inline |
|
inline |
Shows the elements for this ShapeKit.
- Parameters
-
out_def The elements for the shape.
- Returns
- true if elements were set, false otherwise.
|
inline |
Removes the elements for the shape.
- Returns
- A reference to this ShapeKit.
|
inline |
Removes all settings from this ShapeKit.
- Returns
- A reference to this ShapeKit.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.ShapeKit.cs