< Home

< Table of Contents

REFERENCE MANUAL

HPS.EdgeAttributeKit Class Reference

The EdgeAttributeKit class is a user space object, useful for carrying a group attribute settings. More...

Inheritance diagram for HPS.EdgeAttributeKit:
HPS.Object

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 ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.EdgeAttributeKit in_kit)
 Copies all settings from the source EdgeAttributeKit into this object. 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 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 UnsetPattern ()
 Removes the line pattern setting for edges. More...
 
HPS.EdgeAttributeKit UnsetWeight ()
 Removes the weight setting for edges. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 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...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Static Public Member Functions

static HPS.EdgeAttributeKit GetDefault ()
 Creates a EdgeAttributeKit which contains the default settings. More...
 
static bool operator!= (HPS.EdgeAttributeKit a, HPS.EdgeAttributeKit b)
 
static bool operator== (HPS.EdgeAttributeKit a, HPS.EdgeAttributeKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

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.

Constructor & Destructor Documentation

HPS.EdgeAttributeKit.EdgeAttributeKit ( )

Initializes an empty kit.

HPS.EdgeAttributeKit.EdgeAttributeKit ( HPS.EdgeAttributeKit  in_kit)

The copy constructor creates a new EdgeAttributeKit object that contains the same settings as the source object.

Parameters
in_kitThe source object to copy.

Member Function Documentation

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.

bool HPS.EdgeAttributeKit.Equals ( HPS.EdgeAttributeKit  in_kit)

Check if the source EdgeAttributeKit is equivalent to this object.

Parameters
in_kitThe 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.
static HPS.EdgeAttributeKit HPS.EdgeAttributeKit.GetDefault ( )
static

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.

void HPS.EdgeAttributeKit.Set ( HPS.EdgeAttributeKit  in_kit)

Copies all settings from the source EdgeAttributeKit into this object.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_edge_attribute_kit" kindref="compound">EdgeAttributeKit</ref> to copy.
HPS.EdgeAttributeKit HPS.EdgeAttributeKit.SetPattern ( string  in_pattern_name)

Specifies the pattern of edges.

Returns
A reference to this object.
HPS.EdgeAttributeKit HPS.EdgeAttributeKit.SetWeight ( float  in_weight,
HPS.Edge.SizeUnits  in_units 
)

Sets the weight of lines drawn in edge rendering.

Parameters
in_weightThe weight value for edges.
in_unitsThe units applied to in_weight.
Returns
A reference to this object.
HPS.EdgeAttributeKit HPS.EdgeAttributeKit.SetWeight ( float  in_weight)

Sets the weight of lines drawn in edge rendering.

Parameters
in_weightThe weight value for edges.
Returns
A reference to this object.
void HPS.EdgeAttributeKit.Show ( out HPS.EdgeAttributeKit  out_kit)

Copies all settings from this EdgeAttributeKit into the given EdgeAttributeKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_edge_attribute_kit" kindref="compound">EdgeAttributeKit</ref> to populate with the contents of 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_weightThe weight value for edges.
out_unitsThe units applied to in_weight.
Returns
true if the setting is valid, false otherwise.
HPS.EdgeAttributeKit HPS.EdgeAttributeKit.UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.
HPS.EdgeAttributeKit HPS.EdgeAttributeKit.UnsetPattern ( )

Removes the line pattern setting for edges.

Returns
A reference to this object.
HPS.EdgeAttributeKit HPS.EdgeAttributeKit.UnsetWeight ( )

Removes the weight setting for edges.

Returns
A reference to this object.

The documentation for this class was generated from the following file: