HPS::ContourLineControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::ContourLineControl:

Collaboration diagram for HPS::ContourLineControl:

Public Member Functions
	ContourLineControl (SegmentKey &in_seg)
	Initializes a control tied to the segment in_seg. More...
	ContourLineControl (ContourLineControl const &in_that)
	Initializes a control tied to the same object as in_that. More...
	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. More...
ContourLineControl &	operator= (ContourLineControl &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this ContourLineControl thereby avoiding a copy. More...
	~ContourLineControl ()
	Releases a reference to the database object this control is tied to. More...
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
HPS::Type	ObjectType () const
ContourLineControl &	operator= (ContourLineControl const &in_that)
	Share the underlying smart-pointer of the ContourLineControl source. More...
ContourLineControl &	SetVisibility (bool in_state)
	Determines whether contour lines should be rendered. More...
ContourLineControl &	SetPositions (float in_interval, float in_offset)
	Controls the positioning of contour lines. More...
ContourLineControl &	SetPositions (FloatArray const &in_positions)
	Controls the positioning of contour lines. More...
ContourLineControl &	SetPositions (size_t in_count, float const in_positions[])
	Controls the positioning of contour lines. More...
ContourLineControl &	SetColors (RGBColorArray const &in_colors)
	Sets the colors to be used for drawing contour lines. More...
ContourLineControl &	SetColors (size_t in_count, RGBColor const in_colors[])
	Sets the colors to be used for drawing contour lines. More...
ContourLineControl &	SetColors (RGBColor const &in_rgb_color)
	Sets the color to be used for drawing all contour lines. More...
ContourLineControl &	SetPatterns (UTF8Array const &in_patterns)
	Sets the line patterns to be used for drawing contour lines. More...
ContourLineControl &	SetPatterns (size_t in_count, UTF8 const in_patterns[])
	Sets the line patterns to be used for drawing contour lines. More...
ContourLineControl &	SetPatterns (char const *in_pattern)
	Sets the line pattern to be used for drawing all contour lines. More...
ContourLineControl &	SetWeights (FloatArray const &in_weights, LineSizeUnitsArray const &in_units)
	Sets the line weights to be used for drawing contour lines. More...
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. More...
ContourLineControl &	SetWeights (float in_weight, Line::SizeUnits in_units=Line::SizeUnits::ScaleFactor)
	Sets the line weight to be used for drawing all contour lines. More...
ContourLineControl &	SetLighting (bool in_state)
	Controls whether contour lines are lit. More...
ContourLineControl &	UnsetVisibility ()
	Removes the contour line visibility setting. More...
ContourLineControl &	UnsetPositions ()
	Removes the contour line positions setting. More...
ContourLineControl &	UnsetColors ()
	Removes the contour line colors setting. More...
ContourLineControl &	UnsetPatterns ()
	Removes the contour line patterns setting. More...
ContourLineControl &	UnsetWeights ()
	Removes the contour line weights setting. More...
ContourLineControl &	UnsetLighting ()
	Removes the contour line lighting setting. More...
ContourLineControl &	UnsetEverything ()
	Removes all settings from this object. More...
bool	ShowVisibility (bool &out_state) const
	Shows the visibility state of contour lines. More...
bool	ShowPositions (ContourLine::Mode &out_mode, FloatArray &out_positions) const
	Shows the positions of contour lines. More...
bool	ShowColors (RGBColorArray &out_colors) const
	Shows the colors of contour lines. More...
bool	ShowPatterns (UTF8Array &out_patterns) const
	Shows the line patterns of contour lines. More...
bool	ShowWeights (FloatArray &out_weights, LineSizeUnitsArray &out_units) const
	Shows the line weights of contour lines. More...
bool	ShowLighting (bool &out_state) const
	Shows whether contour lines should be lit. More...
virtual bool	Empty () const
	Indicates whether this object has any values set on it. More...
virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...
bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...
intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...
intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::ContourLineControl

Private Member Functions
	ContourLineControl ()
	Private default constructor to prevent instantiation without a segment. More...

Detailed Description

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.

Constructor & Destructor Documentation

ContourLineControl() [1/4]

HPS::ContourLineControl::ContourLineControl ( SegmentKey &  in_seg )

explicit

Initializes a control tied to the segment in_seg.

ContourLineControl() [2/4]

HPS::ContourLineControl::ContourLineControl

(

ContourLineControl const &

in_that

)

Initializes a control tied to the same object as in_that.

ContourLineControl() [3/4]

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.

Parameters

in_that

An rvalue reference to a ContourLineControl to take the impl from.

~ContourLineControl()

HPS::ContourLineControl::~ContourLineControl

(

)

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

ContourLineControl() [4/4]

HPS::ContourLineControl::ContourLineControl ( )

private

Private default constructor to prevent instantiation without a segment.

Member Function Documentation

ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

Empty()

virtual bool HPS::Object::Empty ( ) const

inlinevirtualinherited

Indicates whether this object has any values set on it.

Returns

true if no values are set on this object, false otherwise.

Reimplemented in HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ImportResultsKit, HPS::OBJ::ImportOptionsKit, HPS::Hardcopy::File::ExportOptionsKit, HPS::Stream::ExportOptionsKit, HPS::Stream::ImportResultsKit, HPS::Stream::ImportOptionsKit, HPS::PointCloud::ImportOptionsKit, HPS::PointCloud::ImportResultsKit, HPS::UpdateOptionsKit, HPS::HighlightSearchOptionsKit, HPS::HighlightOptionsKit, HPS::SelectionOptionsKit, HPS::SearchOptionsKit, HPS::CutGeometryGatheringOptionsKit, HPS::ShapeKit, HPS::ShaderKit, HPS::Shader::ImportOptionsKit, HPS::ImageKit, HPS::Image::ImportOptionsKit, HPS::Image::ExportOptionsKit, HPS::TextureOptionsKit, HPS::LinePatternKit, HPS::LinePatternParallelKit, HPS::LinePatternOptionsKit, HPS::GlyphKit, HPS::ApplicationWindowOptionsKit, HPS::OffScreenWindowOptionsKit, HPS::StandAloneWindowOptionsKit, HPS::GridKit, HPS::PolygonKit, HPS::MeshKit, HPS::ShellKit, HPS::ShellRelationResultsKit, HPS::ShellRelationOptionsKit, HPS::ShellOptimizationOptionsKit, HPS::TextKit, HPS::EllipticalArcKit, HPS::EllipseKit, HPS::TrimKit, HPS::NURBSSurfaceKit, HPS::NURBSCurveKit, HPS::SpotlightKit, HPS::InfiniteLineKit, HPS::CuttingSectionKit, HPS::CircularWedgeKit, HPS::CircularArcKit, HPS::CircleKit, HPS::SphereKit, HPS::CylinderKit, HPS::DistantLightKit, HPS::MarkerKit, HPS::LineKit, HPS::AttributeLockKit, HPS::FontInfoState, HPS::WindowInfoKit, HPS::DebuggingKit, HPS::SubwindowKit, HPS::ContourLineKit, HPS::VisualEffectsKit, HPS::TransformMaskKit, HPS::PostProcessEffectsKit, HPS::DrawingAttributeKit, HPS::HiddenLineAttributeKit, HPS::PerformanceKit, HPS::NURBSSurfaceAttributeKit, HPS::MaterialKit, HPS::MaterialMappingKit, HPS::MatrixKit, HPS::CurveAttributeKit, HPS::EdgeAttributeKit, HPS::LineAttributeKit, HPS::TextAttributeKit, HPS::CuttingSectionAttributeKit, HPS::CylinderAttributeKit, HPS::LightingAttributeKit, HPS::SphereAttributeKit, HPS::MarkerAttributeKit, HPS::CullingKit, HPS::ColorInterpolationKit, HPS::TransparencyKit, HPS::SelectabilityKit, HPS::CameraKit, HPS::VisibilityKit, HPS::BoundingKit, HPS::SegmentOptimizationOptionsKit, HPS::Publish::ExportOptionsKit, HPS::Publish::TextFieldKit, HPS::Publish::SignatureFieldKit, HPS::Publish::DropDownListKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::ListBoxKit, HPS::Exchange::ExportSTEPOptionsKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportIGESOptionsKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportU3DOptionsKit, HPS::Exchange::ExportSTLOptionsKit, HPS::Publish::ButtonKit, HPS::Exchange::ExportPRCOptionsKit, HPS::Publish::LinkKit, HPS::Exchange::ExportJTOptionsKit, HPS::Publish::SlideTableKit, HPS::Exchange::ExportACISOptionsKit, HPS::Publish::TableKit, HPS::Exchange::Export3MFOptionsKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Publish::ViewKit, HPS::Exchange::TranslationOptionsKit, HPS::Publish::ArtworkKit, HPS::Publish::AnnotationKit, HPS::ComponentPath, HPS::Exchange::ImportOptionsKit, HPS::Parasolid::ExportOptionsKit, HPS::Exchange::NURBSConversionOptionsKit, HPS::Parasolid::LineTessellationKit, HPS::Exchange::Configuration, HPS::Publish::PageKit, HPS::Parasolid::FacetTessellationKit, HPS::Publish::DocumentKit, HPS::Parasolid::ImportOptionsKit, HPS::DWG::ImportOptionsKit, HPS::OOC::ImportOptionsKit, HPS::Sketchup::ImportOptionsKit, and HPS::Sketchup::ImportResultsKit.

GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns

A unique value shared by all objects of the same class.

GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

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.

Returns

A value unique to an instance of an object and all objects that are backed by the same database resource.

HasType()

bool HPS::Object::HasType ( HPS::Type  in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask

The Type mask to check against this Object.

Returns

true if this Object has the given Type mask, false otherwise.

ObjectType()

HPS::Type HPS::ContourLineControl::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Control.

operator=() [1/2]

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.

Parameters

in_that

An rvalue reference to a ContourLineControl to take the impl from.

Returns

A reference to this ContourLineControl.

operator=() [2/2]

ContourLineControl& HPS::ContourLineControl::operator=

(

ContourLineControl const &

in_that

)

Share the underlying smart-pointer of the ContourLineControl source.

Parameters

in_that

The ContourLineControl source of the assignment.

Returns

A reference to this ContourLineControl.

Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

SetColors() [1/3]

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.

Parameters

in_colors

An array of colors to be used for drawing contour lines.

Returns

A reference to this object.

SetColors() [2/3]

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.

Parameters

in_count	The number of elements in in_colors.
in_colors	An array of colors to be used for drawing contour lines.

Returns

A reference to this object.

SetColors() [3/3]

ContourLineControl& HPS::ContourLineControl::SetColors

(

RGBColor const &

in_rgb_color

)

Sets the color to be used for drawing all contour lines.

Parameters

in_rgb_color

The color to be used for drawing all contour lines

Returns

A reference to this object.

SetLighting()

ContourLineControl& HPS::ContourLineControl::SetLighting

(

bool

in_state

)

Controls whether contour lines are lit.

Parameters

in_state

Whether contour lines are lit.

Returns

A reference to this object.

SetPatterns() [1/3]

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.

Parameters

in_patterns

An array of line pattern names, defined in an accessible portfolio, to be used for drawing contour lines.

Returns

A reference to this object.

SetPatterns() [2/3]

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.

Parameters

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.

Returns

A reference to this object.

SetPatterns() [3/3]

ContourLineControl& HPS::ContourLineControl::SetPatterns

(

char const *

in_pattern

)

Sets the line pattern to be used for drawing all contour lines.

Parameters

in_pattern

The line pattern name, defined in an accessible portfolio, to be used for drawing all contour lines.

Returns

A reference to this object.

SetPositions() [1/3]

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.

Parameters

in_interval	The number of units between contour lines.
in_offset	The starting point for contour lines.

Returns

A reference to this object.

SetPositions() [2/3]

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.

Parameters

in_positions

An array of explicit locations to draw contour lines.

Returns

A reference to this object.

SetPositions() [3/3]

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.

Parameters

in_count	The number of elements in in_positions.
in_positions	An array of explicit locations to draw contour lines.

Returns

A reference to this object.

SetVisibility()

ContourLineControl& HPS::ContourLineControl::SetVisibility

(

bool

in_state

)

Determines whether contour lines should be rendered.

Parameters

in_state

Whether contour lines should be rendered.

Returns

A reference to this object.

SetWeights() [1/3]

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.

Parameters

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.

Returns

A reference to this object.

SetWeights() [2/3]

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.

Parameters

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.

Returns

A reference to this object.

SetWeights() [3/3]

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.

Parameters

in_weight	The line weight to be used for drawing all contour lines.
in_units	The units associated with in_weight.

Returns

A reference to this object.

ShowColors()

bool HPS::ContourLineControl::ShowColors

(

RGBColorArray &

out_colors

)

const

Shows the colors of contour lines.

Parameters

out_colors

An array of colors of contour lines

Returns

true if the setting is valid, false otherwise.

ShowLighting()

bool HPS::ContourLineControl::ShowLighting

(

bool &

out_state

)

const

Shows whether contour lines should be lit.

Parameters

out_state

Whether contour lines should be lit.

Returns

true if the setting is valid, false otherwise.

ShowPatterns()

bool HPS::ContourLineControl::ShowPatterns

(

UTF8Array &

out_patterns

)

const

Shows the line patterns of contour lines.

Parameters

out_patterns

An array of line pattern names for contour lines.

Returns

true if the setting is valid, false otherwise.

ShowPositions()

bool HPS::ContourLineControl::ShowPositions	(	ContourLine::Mode &	out_mode,
		FloatArray &	out_positions
	)		const

Shows the positions of contour lines.

Parameters

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.

Returns

true if the setting is valid, false otherwise.

ShowVisibility()

bool HPS::ContourLineControl::ShowVisibility

(

bool &

out_state

)

const

Shows the visibility state of contour lines.

Parameters

out_state

Whether contour lines should be rendered.

Returns

true if the setting is valid, false otherwise.

ShowWeights()

bool HPS::ContourLineControl::ShowWeights	(	FloatArray &	out_weights,
		LineSizeUnitsArray &	out_units
	)		const

Shows the line weights of contour lines.

Parameters

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

Returns

true if the setting is valid, false otherwise.

Type()

virtual HPS::Type HPS::ContourLineControl::Type ( ) const

inlinevirtual

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.

Returns

The true type of the object in question.

Reimplemented from HPS::Control.

UnsetColors()

ContourLineControl& HPS::ContourLineControl::UnsetColors

(

)

Removes the contour line colors setting.

If the control is attached to a WindowKey this function restores the default value of this setting as specified by ContourLineKit::GetDefault().

Returns

A reference to this object.

UnsetEverything()

ContourLineControl& HPS::ContourLineControl::UnsetEverything

(

)

Removes all settings from this object.

If the control is attached to a WindowKey this function restores the default settings of this control as specified by ContourLineKit::GetDefault().

Returns

A reference to this object.

UnsetLighting()

ContourLineControl& HPS::ContourLineControl::UnsetLighting

(

)

Removes the contour line lighting setting.

If the control is attached to a WindowKey this function restores the default value of this setting as specified by ContourLineKit::GetDefault().

Returns

A reference to this object.

UnsetPatterns()

ContourLineControl& HPS::ContourLineControl::UnsetPatterns

(

)

Removes the contour line patterns setting.

If the control is attached to a WindowKey this function restores the default value of this setting as specified by ContourLineKit::GetDefault().

Returns

A reference to this object.

UnsetPositions()

ContourLineControl& HPS::ContourLineControl::UnsetPositions

(

)

Removes the contour line positions setting.

If the control is attached to a WindowKey this function restores the default value of this setting as specified by ContourLineKit::GetDefault().

Returns

A reference to this object.

UnsetVisibility()

ContourLineControl& HPS::ContourLineControl::UnsetVisibility

(

)

Removes the contour line visibility setting.

If the control is attached to a WindowKey this function restores the default value of this setting as specified by ContourLineKit::GetDefault().

Returns

A reference to this object.

UnsetWeights()

ContourLineControl& HPS::ContourLineControl::UnsetWeights

(

)

Removes the contour line weights setting.

If the control is attached to a WindowKey this function restores the default value of this setting as specified by ContourLineKit::GetDefault().

Returns

A reference to this object.

Member Data Documentation

staticType

const HPS::Type HPS::ContourLineControl::staticType = HPS::Type::ContourLineControl

static

---

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

• hps.h