
Public Member Functions | |
override void | Dispose () |
LineShapeElement () | |
The default constructor creates an empty LineShapeElement object. More... | |
LineShapeElement (HPS.ShapeElement in_that) | |
This constructor creates a LineShapeElement object that contains the same settings as the source ShapeElement. The copy will only be successful if the source shape element is really an upcast of a line shape element. Otherwise the copy will fail and the resulting LineShapeElement will be invalid. More... | |
LineShapeElement (HPS.LineShapeElement in_that) | |
The copy constructor creates a LineShapeElement object that contains the same settings as the source LineShapeElement. More... | |
LineShapeElement (HPS.ShapePoint[] in_points) | |
This constructor creates a LineShapeElement with the specified points. More... | |
LineShapeElement (HPS.ShapePoint in_start, HPS.ShapePoint in_end) | |
This constructor creates a two-point LineShapeElement with the specified points. More... | |
override HPS.Type | ObjectType () |
HPS.LineShapeElement | SetPoints (HPS.ShapePoint[] in_points) |
Sets the points for this LineShapeElement. More... | |
bool | ShowPoints (out HPS.ShapePoint[] out_points) |
Shows the points for this LineShapeElement. More... | |
![]() | |
override void | Dispose () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.ShapeElement in_that) |
Check if the source ShapeElement is equivalent to this ShapeElement. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
void | Set (HPS.ShapeElement in_that) |
Copies the source ShapeElement into this ShapeElement. More... | |
HPS.ShapeElement | SetDisjointed (bool in_state) |
Sets the disjointed state for this ShapeElement. Two shape elements of the same type are automatically joined together if they appear consecutively in the shape element array. LineShapeElement objects are always disjointed. More... | |
HPS.ShapeElement | SetFill (bool in_state) |
Sets the fill mode for this ShapeElement. All shape elements default to being filled, except for Lines which cannot be filled. More... | |
ShapeElement () | |
The default constructor creates an empty ShapeElement object. More... | |
ShapeElement (HPS.ShapeElement in_that) | |
The copy constructor creates a new ShapeElement object that contains the same settings as the source ShapeElement. More... | |
bool | ShowDisjointed (out bool out_state) |
Shows the disjointed state for this ShapeElement. Two shape elements of the same type are automatically joined together if they appear consecutively in the shape element array. LineShapeElement objects are always disjointed. More... | |
bool | ShowFill (out bool out_state) |
Shows the fill mode for this ShapeElement. All shape elements default to being filled, except for Lines which cannot be filled. More... | |
![]() | |
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 () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.ShapeElement a, HPS.ShapeElement b) |
static bool | operator== (HPS.ShapeElement a, HPS.ShapeElement b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The LineShapeElement class is a user space object. It is used to define line elements to make up shapes for text backgrounds.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty LineShapeElement object.
|
inline |
This constructor creates a LineShapeElement object that contains the same settings as the source ShapeElement. The copy will only be successful if the source shape element is really an upcast of a line shape element. Otherwise the copy will fail and the resulting LineShapeElement will be invalid.
- Parameters
-
in_that The source ShapeElement to copy.
|
inline |
The copy constructor creates a LineShapeElement object that contains the same settings as the source LineShapeElement.
- Parameters
-
in_that The source LineShapeElement to copy.
|
inline |
This constructor creates a LineShapeElement with the specified points.
- Parameters
-
in_points The points making up the line.
|
inline |
This constructor creates a two-point LineShapeElement with the specified points.
- Parameters
-
in_start The start of the line. in_end The end of the line.
Member Function Documentation
|
inline |
Sets the points for this LineShapeElement.
- Parameters
-
in_points The points making up the line.
|
inline |
Shows the points for this LineShapeElement.
- Parameters
-
out_points The points for this line
- Returns
- true if points were set, false otherwise.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.LineShapeElement.cs