More...

Inheritance diagram for HPS.LinePatternElement:
HPS.Object HPS.BlankLinePatternElement HPS.GlyphLinePatternElement HPS.SolidLinePatternElement

Public Member Functions

override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.LinePatternElement in_that)
 Check if the source LinePatternElement is equivalent to this LinePatternElement. More...
 
override int GetHashCode ()
 
 LinePatternElement ()
 The default constructor creates an empty LinePatternElement object. More...
 
 LinePatternElement (HPS.LinePatternElement in_that)
 The copy constructor creates a new LinePatternElement object that contains the same settings as the source LinePatternElement. More...
 
override HPS.Type ObjectType ()
 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). More...
 
void Set (HPS.LinePatternElement in_that)
 Copies the source LinePatternElement into this LinePatternElement. More...
 
void SetSize (float in_size, HPS.LinePattern.SizeUnits in_units)
 Sets the size of this LinePatternElement. More...
 
bool ShowSize (out float out_size, out HPS.LinePattern.SizeUnits out_units)
 Shows the size of this LinePatternElement. 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 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.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_thatThe 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_thatThe 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_thatThe 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_sizeThe size of this LinePatternElement.
in_unitsThe 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_sizeThe size of this LinePatternElement.
out_unitsThe 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