
Public Member Functions | |
override void | Dispose () |
EdgeAttributeKit () | |
Initializes an empty kit. More... | |
EdgeAttributeKit (HPS.EdgeAttributeKit in_kit) | |
The copy constructor creates a new EdgeAttributeKit object that contains the same settings as the source object. More... | |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.EdgeAttributeKit in_kit) |
Check if the source EdgeAttributeKit is equivalent to this object. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
void | Set (HPS.EdgeAttributeKit in_kit) |
Copies all settings from the source EdgeAttributeKit into this object. More... | |
HPS.EdgeAttributeKit | SetHardAngle (float in_angle) |
Sets the angle between adjacent faces necessary for the edge between them to be considered a hard edge. More... | |
HPS.EdgeAttributeKit | SetPattern (string in_pattern_name) |
Specifies the pattern of edges. More... | |
HPS.EdgeAttributeKit | SetWeight (float in_weight, HPS.Edge.SizeUnits in_units) |
Sets the weight of lines drawn in edge rendering. More... | |
HPS.EdgeAttributeKit | SetWeight (float in_weight) |
Sets the weight of lines drawn in edge rendering. More... | |
void | Show (out HPS.EdgeAttributeKit out_kit) |
Copies all settings from this EdgeAttributeKit into the given EdgeAttributeKit. More... | |
bool | ShowHardAngle (out float out_angle) |
Shows the weight of lines drawn in edge rendering. More... | |
bool | ShowPattern (out string out_pattern_name) |
Shows the line pattern of the edges. More... | |
bool | ShowWeight (out float out_weight, out HPS.Edge.SizeUnits out_units) |
Shows the weight of lines drawn in edge rendering. More... | |
HPS.EdgeAttributeKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.EdgeAttributeKit | UnsetHardAngle () |
Removes the hard edge angle setting. More... | |
HPS.EdgeAttributeKit | UnsetPattern () |
Removes the line pattern setting for edges. More... | |
HPS.EdgeAttributeKit | UnsetWeight () |
Removes the weight setting for edges. More... | |
![]() | |
override void | Dispose () |
Kit (HPS.Kit in_that) | |
override HPS.Type | ObjectType () |
override 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... | |
![]() | |
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... | |
Static Public Member Functions | |
static HPS.EdgeAttributeKit | GetDefault () |
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. More... | |
static bool | operator!= (HPS.EdgeAttributeKit a, HPS.EdgeAttributeKit b) |
static bool | operator== (HPS.EdgeAttributeKit a, HPS.EdgeAttributeKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The HPS.EdgeAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS.EdgeAttributeKit.GetDefault() will return a kit with values found in this table.
Constructor & Destructor Documentation
|
inline |
Initializes an empty kit.
|
inline |
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.
Member Function Documentation
|
inlinevirtual |
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.
|
inline |
Check if the source EdgeAttributeKit is equivalent to this object.
- Parameters
-
in_kit The source EdgeAttributeKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
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.
|
inline |
Copies all settings from the source EdgeAttributeKit into this object.
- Parameters
-
in_kit The source EdgeAttributeKit to copy.
|
inline |
Sets the angle between adjacent faces necessary for the edge between them to be considered a hard edge.
- Parameters
-
in_angle The angle, in degrees, between the adjacent faces necessary for a hard edge.
- Returns
- A reference to this object.
|
inline |
Specifies the pattern of edges.
- Returns
- A reference to this object.
Programming Guide: Line Patterns
|
inline |
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.
|
inline |
Sets the weight of lines drawn in edge rendering.
- Parameters
-
in_weight The weight value for edges.
- Returns
- A reference to this object.
|
inline |
Copies all settings from this EdgeAttributeKit into the given EdgeAttributeKit.
- Parameters
-
out_kit The EdgeAttributeKit to populate with the contents of this object.
|
inline |
Shows the weight of lines drawn in edge rendering.
- Parameters
-
out_angle The angle, in degrees, between the adjacent faces necessary for a hard edge.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the line pattern of the edges.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
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.
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
|
inline |
Removes the hard edge angle setting.
- Returns
- A reference to this object.
|
inline |
Removes the line pattern setting for edges.
- Returns
- A reference to this object.
|
inline |
Removes the weight setting for edges.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.EdgeAttributeKit.cs