
Public Member Functions | |
override void | Dispose () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.TrimElement in_that) |
Check if the source TrimElement is equivalent to this TrimElement. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
void | Set (HPS.TrimElement in_that) |
Copies the source TrimElement into this TrimElement. More... | |
void | SetCurve (HPS.LineKit in_line) |
Sets a line as the curve for this TrimElement. More... | |
void | SetCurve (HPS.NURBSCurveKit in_curve) |
Sets a NURBS curve as the curve for this TrimElement. More... | |
bool | ShowCurve (out HPS.Trim.Type out_type, out HPS.LineKit out_line, out HPS.NURBSCurveKit out_curve) |
Shows the curve for this TrimElement. More... | |
TrimElement () | |
The default constructor creates an empty TrimElement object. More... | |
TrimElement (HPS.TrimElement in_that) | |
The copy constructor creates a new TrimElement object that contains the same settings as the source TrimElement. More... | |
TrimElement (HPS.LineKit in_line) | |
This constructor creates a TrimElement with a line. More... | |
TrimElement (HPS.NURBSCurveKit in_curve) | |
This constructor creates a TrimElement with a NURBS curve. More... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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... | |
virtual 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... | |
Static Public Member Functions | |
static bool | operator!= (HPS.TrimElement a, HPS.TrimElement b) |
static bool | operator== (HPS.TrimElement a, HPS.TrimElement b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The TrimElement class is a user space object. It is used to specify the curves that are used to define a trim region.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty TrimElement object.
|
inline |
The copy constructor creates a new TrimElement object that contains the same settings as the source TrimElement.
- Parameters
-
in_that The source TrimElement to copy.
|
inline |
This constructor creates a TrimElement with a line.
- Parameters
-
in_line The line for this TrimElement. Only the X and Y coordinates of the points defining the line will be used when the trim region is applied to a surface. The coordinates will be treated as U and V parameter values in the normalized parameter space for the NURBS surface.
|
inline |
This constructor creates a TrimElement with a NURBS curve.
- Parameters
-
in_curve The NURBS curve for this TrimElement. Only the X and Y coordinates of the control points defining the curve will be used when the trim region is applied to a surface. The coordinates will be treated as U and V parameter values in the normalized parameter space for the NURBS surface.
Member Function Documentation
|
inline |
Check if the source TrimElement is equivalent to this TrimElement.
- Parameters
-
in_that The source TrimElement to compare to this TrimElement.
- Returns
- true if the objects are equivalent, false otherwise.
|
inline |
Copies the source TrimElement into this TrimElement.
- Parameters
-
in_that The source TrimElement to copy.
|
inline |
Sets a line as the curve for this TrimElement.
- Parameters
-
in_line The line for this TrimElement. Only the X and Y coordinates of the points defining the line will be used when the trim region is applied to a surface. The coordinates will be treated as U and V parameter values in the normalized parameter space for the NURBS surface.
|
inline |
Sets a NURBS curve as the curve for this TrimElement.
- Parameters
-
in_curve The NURBS curve for this TrimElement. Only the X and Y coordinates of the control points defining the curve will be used when the trim region is applied to a surface. The coordinates will be treated as U and V parameter values in the normalized parameter space for the NURBS surface.
|
inline |
Shows the curve for this TrimElement.
- Parameters
-
out_type The type of curve used for this TrimElement. out_line The line for the trim curve. This is only valid if out_type</type> is NURBSSurface.Line. out_curve The NURBS curve for the trim curve. This is only valid if out_type</type> is NURBSSurface.Curve.
- Returns
- true if a line or NURBS curve was set, false otherwise.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.TrimElement.cs