#include <hps.h>
Public Member Functions | |
ContourLineControl (SegmentKey &in_seg) | |
ContourLineControl (ContourLineControl const &in_that) | |
ContourLineControl (ContourLineControl &&in_that) | |
HPS::Type | ObjectType () const |
ContourLineControl & | operator= (ContourLineControl &&in_that) |
ContourLineControl & | operator= (ContourLineControl const &in_that) |
ContourLineControl & | SetColors (RGBColorArray const &in_colors) |
ContourLineControl & | SetColors (size_t in_count, RGBColor const in_colors[]) |
ContourLineControl & | SetColors (RGBColor const &in_rgb_color) |
ContourLineControl & | SetLighting (bool in_state) |
ContourLineControl & | SetPatterns (UTF8Array const &in_patterns) |
ContourLineControl & | SetPatterns (size_t in_count, UTF8 const in_patterns[]) |
ContourLineControl & | SetPatterns (char const *in_pattern) |
ContourLineControl & | SetPositions (float in_interval, float in_offset) |
ContourLineControl & | SetPositions (FloatArray const &in_positions) |
ContourLineControl & | SetPositions (size_t in_count, float const in_positions[]) |
ContourLineControl & | SetVisibility (bool in_state) |
ContourLineControl & | SetWeights (FloatArray const &in_weights, LineSizeUnitsArray const &in_units) |
ContourLineControl & | SetWeights (size_t in_count, float const in_weights[], Line::SizeUnits const in_units[]) |
ContourLineControl & | SetWeights (float in_weight, Line::SizeUnits in_units=Line::SizeUnits::ScaleFactor) |
bool | ShowColors (RGBColorArray &out_colors) const |
bool | ShowLighting (bool &out_state) const |
bool | ShowPatterns (UTF8Array &out_patterns) const |
bool | ShowPositions (ContourLine::Mode &out_mode, FloatArray &out_positions) const |
bool | ShowVisibility (bool &out_state) const |
bool | ShowWeights (FloatArray &out_weights, LineSizeUnitsArray &out_units) const |
ContourLineControl & | UnsetColors () |
ContourLineControl & | UnsetEverything () |
ContourLineControl & | UnsetLighting () |
ContourLineControl & | UnsetPatterns () |
ContourLineControl & | UnsetPositions () |
ContourLineControl & | UnsetVisibility () |
ContourLineControl & | UnsetWeights () |
~ContourLineControl () | |
![]() | |
Control (Control const &in_that)=default | |
![]() | |
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) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
HPS::Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
The HPS::ContourLineControl class is a smart pointer that is tied to a database object. As its name suggests, this object can be used to control the various attributes related to contour lines, such as pattern, position, color, and weight. This table lists default values for the various segment attributes accessible from HPS::ContourLineControl.
|
explicit |
Initializes a control tied to the segment in_seg.
HPS::ContourLineControl::ContourLineControl | ( | ContourLineControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
HPS::ContourLineControl::ContourLineControl | ( | ContourLineControl && | in_that | ) |
The move constructor creates a ContourLineControl by transferring the underlying impl of the rvalue reference to this ContourLineControl thereby avoiding a copy and allocation.
in_that | An rvalue reference to a ContourLineControl to take the impl from. |
HPS::ContourLineControl::~ContourLineControl | ( | ) |
Releases a reference to the database object this control is tied to.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Control.
ContourLineControl& HPS::ContourLineControl::operator= | ( | ContourLineControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ContourLineControl thereby avoiding a copy.
in_that | An rvalue reference to a ContourLineControl to take the impl from. |
ContourLineControl& HPS::ContourLineControl::operator= | ( | ContourLineControl const & | in_that | ) |
Share the underlying smart-pointer of the ContourLineControl source.
in_that | The ContourLineControl source of the assignment. |
ContourLineControl& HPS::ContourLineControl::SetColors | ( | RGBColorArray const & | in_colors | ) |
Sets the colors to be used for drawing contour lines. If there are more contour lines than colors, the array will be cycled through.
in_colors | An array of colors to be used for drawing contour lines. |
ContourLineControl& HPS::ContourLineControl::SetColors | ( | size_t | in_count, |
RGBColor const | in_colors[] | ||
) |
Sets the colors to be used for drawing contour lines. If there are more contour lines than colors, the array will be cycled through.
in_count | The number of elements in in_colors. |
in_colors | An array of colors to be used for drawing contour lines. |
ContourLineControl& HPS::ContourLineControl::SetColors | ( | RGBColor const & | in_rgb_color | ) |
Sets the color to be used for drawing all contour lines.
in_rgb_color | The color to be used for drawing all contour lines |
ContourLineControl& HPS::ContourLineControl::SetLighting | ( | bool | in_state | ) |
Controls whether contour lines are lit.
in_state | Whether contour lines are lit. |
ContourLineControl& HPS::ContourLineControl::SetPatterns | ( | UTF8Array const & | in_patterns | ) |
Sets the line patterns to be used for drawing contour lines. If there are more contour lines than patterns, the array will be cycled through.
in_patterns | An array of line pattern names, defined in an accessible portfolio, to be used for drawing contour lines. |
ContourLineControl& HPS::ContourLineControl::SetPatterns | ( | size_t | in_count, |
UTF8 const | in_patterns[] | ||
) |
Sets the line patterns to be used for drawing contour lines. If there are more contour lines than patterns, the array will be cycled through.
in_count | The number of elements in in_patterns. |
in_patterns | An array of line pattern names, defined in an accessible portfolio, to be used for drawing contour lines. |
ContourLineControl& HPS::ContourLineControl::SetPatterns | ( | char const * | in_pattern | ) |
Sets the line pattern to be used for drawing all contour lines.
in_pattern | The line pattern name, defined in an accessible portfolio, to be used for drawing all contour lines. |
ContourLineControl& HPS::ContourLineControl::SetPositions | ( | float | in_interval, |
float | in_offset | ||
) |
Controls the positioning of contour lines. This variant creates them at regular intervals with an optional offset.
in_interval | The number of units between contour lines. |
in_offset | The starting point for contour lines. |
ContourLineControl& HPS::ContourLineControl::SetPositions | ( | FloatArray const & | in_positions | ) |
Controls the positioning of contour lines. This variant defines explicit locations that contour lines should appear at.
in_positions | An array of explicit locations to draw contour lines. |
ContourLineControl& HPS::ContourLineControl::SetPositions | ( | size_t | in_count, |
float const | in_positions[] | ||
) |
Controls the positioning of contour lines. This variant defines explicit locations that contour lines should appear at.
in_count | The number of elements in in_positions. |
in_positions | An array of explicit locations to draw contour lines. |
ContourLineControl& HPS::ContourLineControl::SetVisibility | ( | bool | in_state | ) |
Determines whether contour lines should be rendered.
in_state | Whether contour lines should be rendered. |
ContourLineControl& HPS::ContourLineControl::SetWeights | ( | FloatArray const & | in_weights, |
LineSizeUnitsArray const & | in_units | ||
) |
Sets the line weights to be used for drawing contour lines. If there are more contour lines than weights, the array will be cycled through.
in_weights | An array of line weights to be applied to contour lines. |
in_units | An array of line weight units used with the corresponding entry in in_weights. |
ContourLineControl& HPS::ContourLineControl::SetWeights | ( | size_t | in_count, |
float const | in_weights[], | ||
Line::SizeUnits const | in_units[] | ||
) |
Sets the line weights to be used for drawing contour lines. If there are more contour lines than weights, the array will be cycled through.
in_count | The number of elements in both in_weights and in_units. |
in_weights | An array of line weights to be applied to contour lines. |
in_units | An array of line weight units used with the corresponding entry in in_weights. |
ContourLineControl& HPS::ContourLineControl::SetWeights | ( | float | in_weight, |
Line::SizeUnits | in_units = Line::SizeUnits::ScaleFactor |
||
) |
Sets the line weight to be used for drawing all contour lines.
in_weight | The line weight to be used for drawing all contour lines. |
in_units | The units associated with in_weight. |
bool HPS::ContourLineControl::ShowColors | ( | RGBColorArray & | out_colors | ) | const |
Shows the colors of contour lines.
out_colors | An array of colors of contour lines |
bool HPS::ContourLineControl::ShowLighting | ( | bool & | out_state | ) | const |
Shows whether contour lines should be lit.
out_state | Whether contour lines should be lit. |
bool HPS::ContourLineControl::ShowPatterns | ( | UTF8Array & | out_patterns | ) | const |
Shows the line patterns of contour lines.
out_patterns | An array of line pattern names for contour lines. |
bool HPS::ContourLineControl::ShowPositions | ( | ContourLine::Mode & | out_mode, |
FloatArray & | out_positions | ||
) | const |
Shows the positions of contour lines.
out_mode | Whether the positions repeat at some interval or are an explicit list. |
out_positions | If out_mode is Repeating, this will contain the interval and offset, in that order. Otherwise it will contain the explicit list specified. |
bool HPS::ContourLineControl::ShowVisibility | ( | bool & | out_state | ) | const |
Shows the visibility state of contour lines.
out_state | Whether contour lines should be rendered. |
bool HPS::ContourLineControl::ShowWeights | ( | FloatArray & | out_weights, |
LineSizeUnitsArray & | out_units | ||
) | const |
Shows the line weights of contour lines.
out_weights | An array of line weights for contour lines. |
out_units | An array of line weight units, each is applied to the corresponding entry in out_weights |
ContourLineControl& HPS::ContourLineControl::UnsetColors | ( | ) |
Removes the contour line colors setting.
ContourLineControl& HPS::ContourLineControl::UnsetEverything | ( | ) |
Removes all settings from this object.
ContourLineControl& HPS::ContourLineControl::UnsetLighting | ( | ) |
Removes the contour line lighting setting.
ContourLineControl& HPS::ContourLineControl::UnsetPatterns | ( | ) |
Removes the contour line patterns setting.
ContourLineControl& HPS::ContourLineControl::UnsetPositions | ( | ) |
Removes the contour line positions setting.
ContourLineControl& HPS::ContourLineControl::UnsetVisibility | ( | ) |
Removes the contour line visibility setting.
ContourLineControl& HPS::ContourLineControl::UnsetWeights | ( | ) |
Removes the contour line weights setting.