Inheritance diagram for HPS.ShapeKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.ShapeKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.ShapeKit in_kit)
 
HPS.ShapeKit SetElement (HPS.ShapeElement in_element)
 
HPS.ShapeKit SetElements (HPS.ShapeElement[] in_def)
 
 ShapeKit ()
 
 ShapeKit (HPS.ShapeKit in_kit)
 
void Show (out HPS.ShapeKit out_kit)
 
bool ShowElements (out HPS.ShapeElement[] out_def)
 
HPS.ShapeKit UnsetElements ()
 
HPS.ShapeKit UnsetEverything ()
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.ShapeKit GetDefault (HPS.Shape.Default in_default_shape)
 
static bool operator!= (HPS.ShapeKit a, HPS.ShapeKit b)
 
static bool operator== (HPS.ShapeKit a, HPS.ShapeKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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

◆ ShapeKit() [1/2]

HPS.ShapeKit.ShapeKit ( )
inline

The default constructor creates an empty ShapeKit object.

◆ ShapeKit() [2/2]

HPS.ShapeKit.ShapeKit ( HPS.ShapeKit  in_kit)
inline

The copy constructor creates a new ShapeKit object that contains the same settings as the source ShapeKit.

Parameters
in_kitThe source ShapeKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.ShapeKit.Empty ( )
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.

◆ Equals()

bool HPS.ShapeKit.Equals ( HPS.ShapeKit  in_kit)
inline

Check if the source ShapeKit is equivalent to this ShapeKit.

Parameters
in_kitThe source ShapeKit to compare to this ShapeKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.ShapeKit HPS.ShapeKit.GetDefault ( HPS.Shape.Default  in_default_shape)
inlinestatic

Creates a ShapeKit which contains the definition of the specified default shape.

Parameters
in_default_shapeThe default shape for which to get the corresponding ShapeKit.
Returns
A ShapeKit which contains the definition of the specified default shape.

◆ ObjectType()

override HPS.Type HPS.ShapeKit.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Kit.

◆ Set()

void HPS.ShapeKit.Set ( HPS.ShapeKit  in_kit)
inline

Copies the source ShapeKit into this ShapeKit.

Parameters
in_kitThe source ShapeKit to copy.

◆ SetElement()

HPS.ShapeKit HPS.ShapeKit.SetElement ( HPS.ShapeElement  in_element)
inline

Set a single element for this ShapeKit. This must be specified when defining a shape.

Parameters
in_elementA reference to the ShapeElement to set on this kit.
Returns
A reference to this ShapeKit.

◆ SetElements()

HPS.ShapeKit HPS.ShapeKit.SetElements ( HPS.ShapeElement []  in_def)
inline

Sets the elements for this ShapeKit. This must be specified when defining a shape.

Parameters
in_defThe array of elements for the shape.
Returns
A reference to this ShapeKit.

◆ Show()

void HPS.ShapeKit.Show ( out HPS.ShapeKit  out_kit)
inline

Copies this ShapeKit into the given ShapeKit.

Parameters
out_kitThe ShapeKit to populate with the contents of this ShapeKit.

◆ ShowElements()

bool HPS.ShapeKit.ShowElements ( out HPS.ShapeElement []  out_def)
inline

Shows the elements for this ShapeKit.

Parameters
out_defThe elements for the shape.
Returns
true if elements were set, false otherwise.

◆ UnsetElements()

HPS.ShapeKit HPS.ShapeKit.UnsetElements ( )
inline

Removes the elements for the shape.

Returns
A reference to this ShapeKit.

◆ UnsetEverything()

HPS.ShapeKit HPS.ShapeKit.UnsetEverything ( )
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