The SolidLinePatternElement class is a user space object. It is used for specifying solid elements within a line pattern. More...

Public Member Functions | |
override void | Dispose () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | SetColor (HPS.RGBAColor in_color) |
Sets the color for this SolidLinePatternElement. If this is not set, this SolidLinePatternElement will take the effective line (or edge) color in the segment where the line (or edge) pattern is used. More... | |
void | SetMaterialByIndex (float in_material_index) |
Sets the color (by material index) for this SolidLinePatternElement. If this is not set, this SolidLinePatternElement will take the effective line (or edge) color in the segment where the line (or edge) pattern is used. More... | |
bool | ShowColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_color, out float out_index) |
Shows the color for this SolidLinePatternElement. More... | |
SolidLinePatternElement () | |
The default constructor creates an empty SolidLinePatternElement object. More... | |
SolidLinePatternElement (HPS.LinePatternElement in_that) | |
This constructor creates a SolidLinePatternElement 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 solid line pattern element. Otherwise the copy will fail and the resulting SolidLinePatternElement will be invalid. More... | |
SolidLinePatternElement (HPS.SolidLinePatternElement in_that) | |
The copy constructor creates a new SolidLinePatternElement object that contains the same settings as the source SolidLinePatternElement. More... | |
SolidLinePatternElement (float in_size, HPS.LinePattern.SizeUnits in_units) | |
This constructor creates a SolidLinePatternElement with a given size. More... | |
![]() | |
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... | |
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... | |
![]() | |
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. 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 () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.LinePatternElement a, HPS.LinePatternElement b) |
static bool | operator== (HPS.LinePatternElement a, HPS.LinePatternElement b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The SolidLinePatternElement class is a user space object. It is used for specifying solid elements within a line pattern.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty SolidLinePatternElement object.
|
inline |
This constructor creates a SolidLinePatternElement 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 solid line pattern element. Otherwise the copy will fail and the resulting SolidLinePatternElement will be invalid.
- Parameters
-
in_that The source LinePatternElement to copy.
|
inline |
The copy constructor creates a new SolidLinePatternElement object that contains the same settings as the source SolidLinePatternElement.
- Parameters
-
in_that The source SolidLinePatternElement to copy.
|
inline |
This constructor creates a SolidLinePatternElement with a given size.
- Parameters
-
in_size The length of the SolidLinePatternElement. in_units The units for the length of the SolidLinePatternElement.
Member Function Documentation
|
inlinevirtual |
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.LinePatternElement.
|
inline |
Sets the color for this SolidLinePatternElement. If this is not set, this SolidLinePatternElement will take the effective line (or edge) color in the segment where the line (or edge) pattern is used.
- Parameters
-
in_color The color for this SolidLinePatternElement.
|
inline |
Sets the color (by material index) for this SolidLinePatternElement. If this is not set, this SolidLinePatternElement will take the effective line (or edge) color in the segment where the line (or edge) pattern is used.
|
inline |
Shows the color for this SolidLinePatternElement.
- Parameters
-
out_type Indicates which of the following arguments is valid. out_color The color of this SolidLinePatternElement. This is only valid if out_type is Material.Type.RGBAColor. out_index The material index for this SolidLinePatternElement. This is only valid if out_type is Material.Type.MaterialIndex.
- Returns
- true if a color was set, false otherwise.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.SolidLinePatternElement.cs