API Search || Global Search
HPS.BlankLinePatternElement Class Reference

More...

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

Public Member Functions

 BlankLinePatternElement ()
 The default constructor creates an empty BlankLinePatternElement object. More...
 
 BlankLinePatternElement (HPS.LinePatternElement in_that)
 This constructor creates a BlankLinePatternElement object that contains the same settings as the source LinePatternElement. The copy will only be successful if the source line pattern element is really an upcast of a blank line pattern element. Otherwise the copy will fail and the resulting BlankLinePatternElement will be invalid. More...
 
 BlankLinePatternElement (HPS.BlankLinePatternElement in_that)
 The copy constructor creates a new BlankLinePatternElement object that contains the same settings as the source BlankLinePatternElement. More...
 
 BlankLinePatternElement (float in_size, HPS.LinePattern.SizeUnits in_units)
 This constructor creates a BlankLinePatternElement with a given size. More...
 
override void Dispose ()
 
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...
 
- Public Member Functions inherited from HPS.LinePatternElement
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...
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.LinePatternElement
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.LinePatternElement
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 Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The BlankLinePatternElement class is a user space object. It is used for specifying blank elements within a line pattern.

Constructor & Destructor Documentation

HPS.BlankLinePatternElement.BlankLinePatternElement ( )
inline

The default constructor creates an empty BlankLinePatternElement object.

HPS.BlankLinePatternElement.BlankLinePatternElement ( HPS.LinePatternElement  in_that)
inline

This constructor creates a BlankLinePatternElement object that contains the same settings as the source LinePatternElement. The copy will only be successful if the source line pattern element is really an upcast of a blank line pattern element. Otherwise the copy will fail and the resulting BlankLinePatternElement will be invalid.

Parameters
in_thatThe source LinePatternElement to copy.
HPS.BlankLinePatternElement.BlankLinePatternElement ( HPS.BlankLinePatternElement  in_that)
inline

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

Parameters
in_thatThe source BlankLinePatternElement to copy.
HPS.BlankLinePatternElement.BlankLinePatternElement ( float  in_size,
HPS.LinePattern.SizeUnits  in_units 
)
inline

This constructor creates a BlankLinePatternElement with a given size.

Parameters
in_sizeThe length of the BlankLinePatternElement.
in_unitsThe units for the length of the BlankLinePatternElement.

Member Function Documentation

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


The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.BlankLinePatternElement.cs