Overview

Sample Code

Programming Guide

API Reference

Support

HPS::LineAttributeControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::LineAttributeControl:
HPS::Control HPS::Object

Public Member Functions

 LineAttributeControl (SegmentKey &in_seg)
 
 LineAttributeControl (LineAttributeControl const &in_that)
 
 LineAttributeControl (LineAttributeControl &&in_that)
 
HPS::Type ObjectType () const
 
LineAttributeControloperator= (LineAttributeControl &&in_that)
 
LineAttributeControloperator= (LineAttributeControl const &in_that)
 
LineAttributeControlSetPattern (char const *in_pattern)
 
LineAttributeControlSetPattern (char const *in_pattern, LinePatternOptionsKit const &in_options)
 
LineAttributeControlSetWeight (float in_weight, Line::SizeUnits in_units=Line::SizeUnits::ScaleFactor)
 
bool ShowPattern (UTF8 &out_pattern, LinePatternOptionsKit &out_options) const
 
bool ShowWeight (float &out_weight, Line::SizeUnits &out_units) const
 
LineAttributeControlUnsetEverything ()
 
LineAttributeControlUnsetPattern ()
 
LineAttributeControlUnsetWeight ()
 
 ~LineAttributeControl ()
 
- Public Member Functions inherited from HPS::Control
 Control (Control const &in_that)=default
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
HPS::Type Type () const
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Control
 Control (Control &&in_that)
 
Controloperator= (Control &&in_that)
 

Detailed Description

The HPS::LineAttributeControl class is a smart pointer that is tied to a database object. This control allows you to manipulate the weight and pattern of lines and polylines.

This table lists default values for the various segment attributes accessible from HPS::LineAttributeControl.

Constructor & Destructor Documentation

HPS::LineAttributeControl::LineAttributeControl ( SegmentKey in_seg)
explicit

Initializes a control tied to the segment in_seg.

HPS::LineAttributeControl::LineAttributeControl ( LineAttributeControl const &  in_that)

Initializes a control tied to the same object as in_that.

HPS::LineAttributeControl::LineAttributeControl ( LineAttributeControl &&  in_that)

The move constructor creates a LineAttributeControl by transferring the underlying impl of the rvalue reference to this LineAttributeControl thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a LineAttributeControl to take the impl from.
HPS::LineAttributeControl::~LineAttributeControl ( )

Releases a reference to the database object this control is tied to.

Member Function Documentation

HPS::Type HPS::LineAttributeControl::ObjectType ( ) const
inlinevirtual

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::Control.

LineAttributeControl& HPS::LineAttributeControl::operator= ( LineAttributeControl &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this LineAttributeControl thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a LineAttributeControl to take the impl from.
Returns
A reference to this LineAttributeControl.
LineAttributeControl& HPS::LineAttributeControl::operator= ( LineAttributeControl const &  in_that)

Share the underlying smart-pointer of the LineAttributeControl source.

Parameters
in_thatThe LineAttributeControl source of the assignment.
Returns
A reference to this LineAttributeControl.
LineAttributeControl& HPS::LineAttributeControl::SetPattern ( char const *  in_pattern)

Specifies the pattern of lines.

Parameters
in_patternThe name of a line pattern, defined in a portfolio that is accessible.
Returns
A reference to this object.
LineAttributeControl& HPS::LineAttributeControl::SetPattern ( char const *  in_pattern,
LinePatternOptionsKit const &  in_options 
)

Specifies the pattern of lines.

Parameters
in_patternThe 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.
LineAttributeControl& HPS::LineAttributeControl::SetWeight ( float  in_weight,
Line::SizeUnits  in_units = Line::SizeUnits::ScaleFactor 
)

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.
bool HPS::LineAttributeControl::ShowPattern ( UTF8 out_pattern,
LinePatternOptionsKit out_options 
) const

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.
bool HPS::LineAttributeControl::ShowWeight ( float &  out_weight,
Line::SizeUnits out_units 
) const

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.
LineAttributeControl& HPS::LineAttributeControl::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.
LineAttributeControl& HPS::LineAttributeControl::UnsetPattern ( )

Removes the line pattern setting for lines.

Returns
A reference to this object.
LineAttributeControl& HPS::LineAttributeControl::UnsetWeight ( )

Removes the weight setting for lines.

Returns
A reference to this object.

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