The EdgeAttributeKit class is a user space object, useful for carrying a group attribute settings.
More...
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
HandleRef | scptr |
|
The EdgeAttributeKit class is a user space object, useful for carrying a group attribute settings.
Calling EdgeAttributeKit::GetDefault() will return a kit with values found in this table.
HPS.EdgeAttributeKit.EdgeAttributeKit |
( |
| ) |
|
Initializes an empty kit.
The copy constructor creates a new EdgeAttributeKit object that contains the same settings as the source object.
- Parameters
-
in_kit | The source object to copy. |
override bool HPS.EdgeAttributeKit.Empty |
( |
| ) |
|
|
virtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from HPS.Object.
Check if the source EdgeAttributeKit is equivalent to this object.
- Parameters
-
in_kit | The source <ref refid="class_h_p_s_1_1_edge_attribute_kit" kindref="compound">EdgeAttributeKit</ref> to compare to this object. |
- Returns
- true if the objects are equivalent, false otherwise.
Creates a EdgeAttributeKit which contains the default settings.
The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
- Returns
- A EdgeAttributeKit with the default settings.
override HPS.Type HPS.EdgeAttributeKit.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.
Copies all settings from the source EdgeAttributeKit into this object.
- Parameters
-
in_kit | The source <ref refid="class_h_p_s_1_1_edge_attribute_kit" kindref="compound">EdgeAttributeKit</ref> to copy. |
Specifies the pattern of edges.
- Returns
- A reference to this object.
Sets the weight of lines drawn in edge rendering.
- Parameters
-
in_weight | The weight value for edges. |
in_units | The units applied to in_weight. |
- Returns
- A reference to this object.
Sets the weight of lines drawn in edge rendering.
- Parameters
-
in_weight | The weight value for edges. |
- Returns
- A reference to this object.
bool HPS.EdgeAttributeKit.ShowPattern |
( |
out string |
out_pattern_name | ) |
|
Shows the line pattern of the edges.
- Returns
- true if the setting is valid, false otherwise.
bool HPS.EdgeAttributeKit.ShowWeight |
( |
out float |
out_weight, |
|
|
out HPS.Edge.SizeUnits |
out_units |
|
) |
| |
Shows the weight of lines drawn in edge rendering.
- Parameters
-
out_weight | The weight value for edges. |
out_units | The units applied to in_weight. |
- Returns
- true if the setting is valid, false otherwise.
Removes all settings from this object.
- Returns
- A reference to this object.
Removes the line pattern setting for edges.
- Returns
- A reference to this object.
Removes the weight setting for edges.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file: