Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.TrimKit Class Reference

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

Inheritance diagram for HPS.TrimKit:
HPS.Object

Public Member Functions

override void Dispose ()
 
 TrimKit ()
 The default constructor creates an empty TrimKit object. More...
 
 TrimKit (HPS.TrimKit in_kit)
 The copy constructor creates a new TrimKit object that contains the same settings as the source TrimKit. More...
 
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.TrimKit in_kit)
 Copies the source TrimKit into this TrimKit. More...
 
void Show (out HPS.TrimKit out_kit)
 Copies this TrimKit into the given TrimKit. More...
 
override bool Empty ()
 Indicates whether this TrimKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.TrimKit in_kit)
 Check if the source TrimKit is equivalent to this TrimKit. More...
 
HPS.TrimKit SetShape (HPS.TrimElement[] in_shape)
 Sets the shape of the trim region. The shape is a collection of trim elements. More...
 
HPS.TrimKit SetOperation (HPS.Trim.Operation in_operation)
 Sets the operation for the trim. More...
 
HPS.TrimKit UnsetShape ()
 Removes the trim elements defining a trim region. More...
 
HPS.TrimKit UnsetOperation ()
 Removes the operation for the trim. More...
 
HPS.TrimKit UnsetEverything ()
 Removes all settings from this TrimKit. More...
 
bool ShowShape (out HPS.TrimElement[] out_shape)
 Shows the shape of the trim region. More...
 
bool ShowOperation (out HPS.Trim.Operation out_operation)
 Shows the operation for the trim. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
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...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
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...
 

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
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

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

HPS.TrimKit.TrimKit ( )
inline

The default constructor creates an empty TrimKit object.

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 <ref refid="class_h_p_s_1_1_trim_kit" kindref="compound">TrimKit</ref> to copy.

Member Function Documentation

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.

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

Check if the source TrimKit is equivalent to this TrimKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_trim_kit" kindref="compound">TrimKit</ref> to compare to this <ref refid="class_h_p_s_1_1_trim_kit" kindref="compound">TrimKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
override HPS.Type HPS.TrimKit.ObjectType ( )
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.Object.

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

Copies the source TrimKit into this TrimKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_trim_kit" kindref="compound">TrimKit</ref> to copy.
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.
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_countSize of the following array.
in_shapeAn array of trim elements defining a trim region.
Returns
A reference to this TrimKit.
void HPS.TrimKit.Show ( out HPS.TrimKit  out_kit)
inline

Copies this TrimKit into the given TrimKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_trim_kit" kindref="compound">TrimKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_trim_kit" kindref="compound">TrimKit</ref>.
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.
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.
HPS.TrimKit HPS.TrimKit.UnsetEverything ( )
inline

Removes all settings from this TrimKit.

Returns
A reference to this TrimKit.
HPS.TrimKit HPS.TrimKit.UnsetOperation ( )
inline

Removes the operation for the trim.

Returns
A reference to this TrimKit.
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: