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)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.TrimElement in_that)
 
void SetCurve (HPS.LineKit in_line)
 
void SetCurve (HPS.NURBSCurveKit in_curve)
 
bool ShowCurve (out HPS.Trim.Type out_type, out HPS.LineKit out_line, out HPS.NURBSCurveKit out_curve)
 
 TrimElement ()
 
 TrimElement (HPS.TrimElement in_that)
 
 TrimElement (HPS.LineKit in_line)
 
 TrimElement (HPS.NURBSCurveKit in_curve)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

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
 

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

◆ TrimElement() [1/4]

HPS.TrimElement.TrimElement ( )
inline

The default constructor creates an empty TrimElement object.

◆ TrimElement() [2/4]

HPS.TrimElement.TrimElement ( HPS.TrimElement  in_that)
inline

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

Parameters
in_thatThe source TrimElement to copy.

◆ TrimElement() [3/4]

HPS.TrimElement.TrimElement ( HPS.LineKit  in_line)
inline

This constructor creates a TrimElement with a line.

Parameters
in_lineThe 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.

◆ TrimElement() [4/4]

HPS.TrimElement.TrimElement ( HPS.NURBSCurveKit  in_curve)
inline

This constructor creates a TrimElement with a NURBS curve.

Parameters
in_curveThe 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

◆ Equals()

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

Check if the source TrimElement is equivalent to this TrimElement.

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

◆ ObjectType()

override HPS.Type HPS.TrimElement.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.Object.

◆ Set()

void HPS.TrimElement.Set ( HPS.TrimElement  in_that)
inline

Copies the source TrimElement into this TrimElement.

Parameters
in_thatThe source TrimElement to copy.

◆ SetCurve() [1/2]

void HPS.TrimElement.SetCurve ( HPS.LineKit  in_line)
inline

Sets a line as the curve for this TrimElement.

Parameters
in_lineThe 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.

◆ SetCurve() [2/2]

void HPS.TrimElement.SetCurve ( HPS.NURBSCurveKit  in_curve)
inline

Sets a NURBS curve as the curve for this TrimElement.

Parameters
in_curveThe 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.

◆ ShowCurve()

bool HPS.TrimElement.ShowCurve ( out HPS.Trim.Type  out_type,
out HPS.LineKit  out_line,
out HPS.NURBSCurveKit  out_curve 
)
inline

Shows the curve for this TrimElement.

Parameters
out_typeThe type of curve used for this TrimElement.
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:
  • internals/hps_core/source/cs/HPS.TrimElement.cs