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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.TrimKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.TrimKit in_kit)
 
HPS.TrimKit SetOperation (HPS.Trim.Operation in_operation)
 
HPS.TrimKit SetShape (HPS.TrimElement[] in_shape)
 
HPS.TrimKit SetShape (HPS.TrimElement in_shape)
 
void Show (out HPS.TrimKit out_kit)
 
bool ShowOperation (out HPS.Trim.Operation out_operation)
 
bool ShowShape (out HPS.TrimElement[] out_shape)
 
 TrimKit ()
 
 TrimKit (HPS.TrimKit in_kit)
 
HPS.TrimKit UnsetEverything ()
 
HPS.TrimKit UnsetOperation ()
 
HPS.TrimKit UnsetShape ()
 
- 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 bool operator!= (HPS.TrimKit a, HPS.TrimKit b)
 
static bool operator== (HPS.TrimKit a, HPS.TrimKit 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 TrimKit class is a user space object. It is used to define trim curves (either NURBS curves or lines) that can be used to trim NURBS surfaces.

Constructor & Destructor Documentation

◆ TrimKit() [1/2]

HPS.TrimKit.TrimKit ( )
inline

The default constructor creates an empty TrimKit object.

◆ TrimKit() [2/2]

HPS.TrimKit.TrimKit ( HPS.TrimKit  in_kit)
inline

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

Parameters
in_kitThe source TrimKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.TrimKit.Empty ( )
inlinevirtual

Indicates whether this TrimKit has any values set on it.

Returns
true if no values are set on this TrimKit, false otherwise.

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source TrimKit is equivalent to this TrimKit.

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

◆ ObjectType()

override HPS.Type HPS.TrimKit.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.TrimKit.Set ( HPS.TrimKit  in_kit)
inline

Copies the source TrimKit into this TrimKit.

Parameters
in_kitThe source TrimKit to copy.

◆ SetOperation()

HPS.TrimKit HPS.TrimKit.SetOperation ( HPS.Trim.Operation  in_operation)
inline

Sets the operation for the trim.

Parameters
in_operationThe operation for the trim.
Returns
A reference to this TrimKit.

◆ SetShape() [1/2]

HPS.TrimKit HPS.TrimKit.SetShape ( HPS.TrimElement []  in_shape)
inline

Sets the shape of the trim region. The shape is a collection of trim elements.

Parameters
in_shapeAn array of trim elements defining a trim region.
Returns
A reference to this TrimKit.

◆ SetShape() [2/2]

HPS.TrimKit HPS.TrimKit.SetShape ( HPS.TrimElement  in_shape)
inline

Sets the shape of the trim region.

Parameters
in_shapeAn trim element defining a trim region.
Returns
A reference to this TrimKit.

◆ Show()

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

Copies this TrimKit into the given TrimKit.

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

◆ ShowOperation()

bool HPS.TrimKit.ShowOperation ( out HPS.Trim.Operation  out_operation)
inline

Shows the operation for the trim.

Parameters
out_operationThe operation for the trim.
Returns
true if an operation was set, false otherwise.

◆ ShowShape()

bool HPS.TrimKit.ShowShape ( out HPS.TrimElement []  out_shape)
inline

Shows the shape of the trim region.

Parameters
out_shapeThe array of trim elements defining a trim region.
Returns
true if a shape was set, false otherwise.

◆ UnsetEverything()

HPS.TrimKit HPS.TrimKit.UnsetEverything ( )
inline

Removes all settings from this TrimKit.

Returns
A reference to this TrimKit.

◆ UnsetOperation()

HPS.TrimKit HPS.TrimKit.UnsetOperation ( )
inline

Removes the operation for the trim.

Returns
A reference to this TrimKit.

◆ UnsetShape()

HPS.TrimKit HPS.TrimKit.UnsetShape ( )
inline

Removes the trim elements defining a trim region.

Returns
A reference to this TrimKit.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.TrimKit.cs