< Home

< Table of Contents

REFERENCE MANUAL

HPS.TrimElement Class Reference

The TrimElement class is a user space object. More...

Inheritance diagram for HPS.TrimElement:
HPS.Object

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 ()
 This function returns the type the object, as declared. More...
 
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...
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 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...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Static Public Member Functions

static bool operator!= (HPS.TrimElement a, HPS.TrimElement b)
 
static bool operator== (HPS.TrimElement a, HPS.TrimElement 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
 
HandleRef scptr
 

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

HPS.TrimElement.TrimElement ( )

The default constructor creates an empty TrimElement object.

HPS.TrimElement.TrimElement ( HPS.TrimElement  in_that)

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

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_trim_element" kindref="compound">TrimElement</ref> to copy.
HPS.TrimElement.TrimElement ( HPS.LineKit  in_line)

This constructor creates a TrimElement with a line.

Parameters
in_lineThe line for this <ref refid="class_h_p_s_1_1_trim_element" kindref="compound">TrimElement</ref>. 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.
HPS.TrimElement.TrimElement ( HPS.NURBSCurveKit  in_curve)

This constructor creates a TrimElement with a NURBS curve.

Parameters
in_curveThe NURBS curve for this <ref refid="class_h_p_s_1_1_trim_element" kindref="compound">TrimElement</ref>. 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

bool HPS.TrimElement.Equals ( HPS.TrimElement  in_that)

Check if the source TrimElement is equivalent to this TrimElement.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_trim_element" kindref="compound">TrimElement</ref> to compare to this <ref refid="class_h_p_s_1_1_trim_element" kindref="compound">TrimElement</ref>.
Returns
true if the objects are equivalent, false otherwise.
override HPS.Type HPS.TrimElement.ObjectType ( )
virtual

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.TrimElement.Set ( HPS.TrimElement  in_that)

Copies the source TrimElement into this TrimElement.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_trim_element" kindref="compound">TrimElement</ref> to copy.
void HPS.TrimElement.SetCurve ( HPS.LineKit  in_line)

Sets a line as the curve for this TrimElement.

Parameters
in_lineThe line for this <ref refid="class_h_p_s_1_1_trim_element" kindref="compound">TrimElement</ref>. 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.
void HPS.TrimElement.SetCurve ( HPS.NURBSCurveKit  in_curve)

Sets a NURBS curve as the curve for this TrimElement.

Parameters
in_curveThe NURBS curve for this <ref refid="class_h_p_s_1_1_trim_element" kindref="compound">TrimElement</ref>. 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.
bool HPS.TrimElement.ShowCurve ( out HPS.Trim.Type  out_type,
out HPS.LineKit  out_line,
out HPS.NURBSCurveKit  out_curve 
)

Shows the curve for this TrimElement.

Parameters
out_typeThe type of curve used for this <ref refid="class_h_p_s_1_1_trim_element" kindref="compound">TrimElement</ref>.
out_lineThe line for the trim curve. This is only valid if out_type</type> is NURBSSurface::Line.
out_curveThe 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: