< Home

< Table of Contents

REFERENCE MANUAL

HPS.LinePatternElement Class Reference

The LinePatternElement class is a user space object. 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. 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 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.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
 
HandleRef scptr
 

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

HPS.LinePatternElement.LinePatternElement ( )

The default constructor creates an empty LinePatternElement object.

HPS.LinePatternElement.LinePatternElement ( HPS.LinePatternElement  in_that)

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

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_line_pattern_element" kindref="compound">LinePatternElement</ref> to copy.

Member Function Documentation

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

Check if the source LinePatternElement is equivalent to this LinePatternElement.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_line_pattern_element" kindref="compound">LinePatternElement</ref> to compare to this <ref refid="class_h_p_s_1_1_line_pattern_element" kindref="compound">LinePatternElement</ref>.
Returns
true if the objects are equivalent, false otherwise.
override HPS.Type HPS.LinePatternElement.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.

Reimplemented in HPS.SolidLinePatternElement.

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

Copies the source LinePatternElement into this LinePatternElement.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_line_pattern_element" kindref="compound">LinePatternElement</ref> to copy.
void HPS.LinePatternElement.SetSize ( float  in_size,
HPS.LinePattern.SizeUnits  in_units 
)

Sets the size of this LinePatternElement.

Parameters
in_sizeThe size of this <ref refid="class_h_p_s_1_1_line_pattern_element" kindref="compound">LinePatternElement</ref>.
in_unitsThe units for the size of this <ref refid="class_h_p_s_1_1_line_pattern_element" kindref="compound">LinePatternElement</ref>.
bool HPS.LinePatternElement.ShowSize ( out float  out_size,
out HPS.LinePattern.SizeUnits  out_units 
)

Shows the size of this LinePatternElement.

Parameters
out_sizeThe size of this <ref refid="class_h_p_s_1_1_line_pattern_element" kindref="compound">LinePatternElement</ref>.
out_unitsThe units for the size of this <ref refid="class_h_p_s_1_1_line_pattern_element" kindref="compound">LinePatternElement</ref>.
Returns
true if a size was set, false otherwise.

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