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 () |
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) | |
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 (float in_size, HPS.LinePattern.SizeUnits in_units) | |
This constructor creates a SolidLinePatternElement with a given size. More... | |
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... | |
![]() | |
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... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.LinePatternElement in_that) |
Check if the source LinePatternElement is equivalent to 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... | |
![]() | |
IntPtr | GetClassID () |
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... | |
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... | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
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... | |
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 > () |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The SolidLinePatternElement class is a user space object. It is used for specifying solid elements within a line pattern.
|
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.
in_that | The source <ref refid="class_h_p_s_1_1_line_pattern_element" kindref="compound">LinePatternElement</ref> to copy. |
|
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.
in_that | The source <ref refid="class_h_p_s_1_1_line_pattern_element" kindref="compound">LinePatternElement</ref> to copy. |
|
inline |
This constructor creates a SolidLinePatternElement with a given size.
in_size | The length of the <ref refid="class_h_p_s_1_1_solid_line_pattern_element" kindref="compound">SolidLinePatternElement</ref>. |
in_units | The units for the length of the <ref refid="class_h_p_s_1_1_solid_line_pattern_element" kindref="compound">SolidLinePatternElement</ref>. |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
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.
in_color | The color for this <ref refid="class_h_p_s_1_1_solid_line_pattern_element" kindref="compound">SolidLinePatternElement</ref>. |
|
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.
out_type | Indicates which of the following arguments is valid. |
out_color | The color of this <ref refid="class_h_p_s_1_1_solid_line_pattern_element" kindref="compound">SolidLinePatternElement</ref>. This is only valid if out_type is <ref refid="class_h_p_s_1_1_material_1a2ec9b893c8c5b2e37ec82aff0c82a18da5769501214f669cb063fd410bb5eb822" kindref="member">Material::Type::ExplicitRGBAColor</ref>. |
out_index | The material index for this <ref refid="class_h_p_s_1_1_solid_line_pattern_element" kindref="compound">SolidLinePatternElement</ref>. This is only valid if out_type is <ref refid="class_h_p_s_1_1_material_1a2ec9b893c8c5b2e37ec82aff0c82a18da3e21f60632b7774f92151ddc6b0c64b5" kindref="member">Material::Type::MaterialIndex</ref>. |