Inheritance diagram for HPS.LineAttributeKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.LineAttributeKit in_kit)
 
override int GetHashCode ()
 
 LineAttributeKit ()
 
 LineAttributeKit (HPS.LineAttributeKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.LineAttributeKit in_kit)
 
HPS.LineAttributeKit SetPattern (string in_name)
 
HPS.LineAttributeKit SetPattern (string in_name, HPS.LinePatternOptionsKit in_options)
 
HPS.LineAttributeKit SetWeight (float in_weight, HPS.Line.SizeUnits in_units)
 
HPS.LineAttributeKit SetWeight (float in_weight)
 
void Show (out HPS.LineAttributeKit out_kit)
 
bool ShowPattern (out string out_pattern, out HPS.LinePatternOptionsKit out_options)
 
bool ShowWeight (out float out_weight, out HPS.Line.SizeUnits out_units)
 
HPS.LineAttributeKit UnsetEverything ()
 
HPS.LineAttributeKit UnsetPattern ()
 
HPS.LineAttributeKit UnsetWeight ()
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.LineAttributeKit GetDefault ()
 
static bool operator!= (HPS.LineAttributeKit a, HPS.LineAttributeKit b)
 
static bool operator== (HPS.LineAttributeKit a, HPS.LineAttributeKit 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
 

Detailed Description

The HPS.LineAttributeKit class is a user space object, useful for carrying a group of attribute settings related to lines. Calling HPS.LineAttributeKit.GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ LineAttributeKit() [1/2]

HPS.LineAttributeKit.LineAttributeKit ( )
inline

Initializes an empty kit.

◆ LineAttributeKit() [2/2]

HPS.LineAttributeKit.LineAttributeKit ( HPS.LineAttributeKit  in_kit)
inline

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

Parameters
in_kitThe source object to copy.

Member Function Documentation

◆ Empty()

override bool HPS.LineAttributeKit.Empty ( )
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.

◆ Equals()

bool HPS.LineAttributeKit.Equals ( HPS.LineAttributeKit  in_kit)
inline

Check if the source LineAttributeKit is equivalent to this object.

Parameters
in_kitThe source LineAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.LineAttributeKit HPS.LineAttributeKit.GetDefault ( )
inlinestatic

Creates a LineAttributeKit 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 LineAttributeKit with the default settings.

◆ ObjectType()

override HPS.Type HPS.LineAttributeKit.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Kit.

◆ Set()

void HPS.LineAttributeKit.Set ( HPS.LineAttributeKit  in_kit)
inline

Copies all settings from the source LineAttributeKit into this object.

Parameters
in_kitThe source LineAttributeKit to copy.

◆ SetPattern() [1/2]

HPS.LineAttributeKit HPS.LineAttributeKit.SetPattern ( string  in_name)
inline

Specifies the pattern of lines.

Parameters
in_nameThe name of a line pattern, defined in a portfolio that is accessible.
Returns
A reference to this object.
See also
Programming Guide: Line Patterns

◆ SetPattern() [2/2]

HPS.LineAttributeKit HPS.LineAttributeKit.SetPattern ( string  in_name,
HPS.LinePatternOptionsKit  in_options 
)
inline

Specifies the pattern of lines.

Parameters
in_nameThe name of a line pattern, defined in a portfolio that is accessible.
in_optionsA set of options that modify how the named line pattern is applied.
Returns
A reference to this object.
See also
Programming Guide: Line Patterns

◆ SetWeight() [1/2]

HPS.LineAttributeKit HPS.LineAttributeKit.SetWeight ( float  in_weight,
HPS.Line.SizeUnits  in_units 
)
inline

Sets the weight of lines.

Parameters
in_weightThe weight value for lines.
in_unitsThe units applied to in_weight.
Returns
A reference to this object.

◆ SetWeight() [2/2]

HPS.LineAttributeKit HPS.LineAttributeKit.SetWeight ( float  in_weight)
inline

Sets the weight of lines.

Parameters
in_weightThe weight value for lines.
Returns
A reference to this object.

◆ Show()

void HPS.LineAttributeKit.Show ( out HPS.LineAttributeKit  out_kit)
inline

Copies all settings from this LineAttributeKit into the given LineAttributeKit.

Parameters
out_kitThe LineAttributeKit to populate with the contents of this object.

◆ ShowPattern()

bool HPS.LineAttributeKit.ShowPattern ( out string  out_pattern,
out HPS.LinePatternOptionsKit  out_options 
)
inline

Shows the pattern used to draw lines.

Parameters
out_patternThe name of a line pattern, defined in a portfolio that is accessible.
out_optionsA set of options that modify how the named line pattern is applied.
Returns
true if the setting is valid, false otherwise.

◆ ShowWeight()

bool HPS.LineAttributeKit.ShowWeight ( out float  out_weight,
out HPS.Line.SizeUnits  out_units 
)
inline

Shows the weight of lines.

Parameters
out_weightThe weight value for lines.
out_unitsThe units applied to in_weight.
Returns
true if the setting is valid, false otherwise.

◆ UnsetEverything()

HPS.LineAttributeKit HPS.LineAttributeKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetPattern()

HPS.LineAttributeKit HPS.LineAttributeKit.UnsetPattern ( )
inline

Removes the line pattern setting for lines.

Returns
A reference to this object.

◆ UnsetWeight()

HPS.LineAttributeKit HPS.LineAttributeKit.UnsetWeight ( )
inline

Removes the weight setting for lines.

Returns
A reference to this object.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.LineAttributeKit.cs