HPS.LinePatternElement Class Reference

Inheritance diagram for HPS.LinePatternElement:

Public Member Functions
override void	Dispose ()
override bool	Equals (System.Object obj)
bool	Equals (HPS.LinePatternElement in_that)
override int	GetHashCode ()
	LinePatternElement ()
	LinePatternElement (HPS.LinePatternElement in_that)
override HPS.Type	ObjectType ()
void	Set (HPS.LinePatternElement in_that)
void	SetSize (float in_size, HPS.LinePattern.SizeUnits in_units)
bool	ShowSize (out float out_size, out HPS.LinePattern.SizeUnits out_units)
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.LinePatternElement a, HPS.LinePatternElement b)
static bool	operator== (HPS.LinePatternElement a, HPS.LinePatternElement 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 LinePatternElement class is a user space object. It is the base class for other line pattern element types. Line pattern elements are used to define a pattern that can be assigned lines or edges.

Constructor & Destructor Documentation

LinePatternElement() [1/2]

HPS.LinePatternElement.LinePatternElement ( )

inline

The default constructor creates an empty LinePatternElement object.

LinePatternElement() [2/2]

HPS.LinePatternElement.LinePatternElement ( HPS.LinePatternElement  in_that )

inline

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

Parameters

in_that

The source LinePatternElement to copy.

Member Function Documentation

Equals()

bool HPS.LinePatternElement.Equals ( HPS.LinePatternElement  in_that )

inline

Check if the source LinePatternElement is equivalent to this LinePatternElement.

Parameters

in_that

The source LinePatternElement to compare to this LinePatternElement.

Returns

true if the objects are equivalent, false otherwise.

ObjectType()

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

Reimplemented in HPS.SolidLinePatternElement.

Set()

void HPS.LinePatternElement.Set ( HPS.LinePatternElement  in_that )

inline

Copies the source LinePatternElement into this LinePatternElement.

Parameters

in_that

The source LinePatternElement to copy.

SetSize()

void HPS.LinePatternElement.SetSize ( float  in_size, HPS.LinePattern.SizeUnits  in_units  )

inline

Sets the size of this LinePatternElement.

Parameters

in_size	The size of this LinePatternElement.
in_units	The units for the size of this LinePatternElement.

ShowSize()

bool HPS.LinePatternElement.ShowSize ( out float  out_size, out HPS.LinePattern.SizeUnits  out_units  )

inline

Shows the size of this LinePatternElement.

Parameters

out_size	The size of this LinePatternElement.
out_units	The units for the size of this LinePatternElement.

Returns

true if a size was set, false otherwise.

---

The documentation for this class was generated from the following file:

• internals/hps_core/source/cs/HPS.LinePatternElement.cs