HPS::HiddenLineAttributeControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::HiddenLineAttributeControl:

Collaboration diagram for HPS::HiddenLineAttributeControl:

Public Member Functions
	HiddenLineAttributeControl (SegmentKey &in_seg)
	Initializes a control tied to the segment in_seg. More...
	HiddenLineAttributeControl (HiddenLineAttributeControl const &in_that)
	Initializes a control tied to the same object as in_that. More...
	HiddenLineAttributeControl (HiddenLineAttributeControl &&in_that)
	The move constructor creates a HiddenLineAttributeKit by transferring the underlying impl of the rvalue reference to this HiddenLineAttributeKit thereby avoiding a copy and allocation. More...
HiddenLineAttributeControl &	operator= (HiddenLineAttributeControl &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this HiddenLineAttributeKit thereby avoiding a copy. More...
	~HiddenLineAttributeControl ()
	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
HiddenLineAttributeControl &	operator= (HiddenLineAttributeControl const &in_that)
	Share the underlying smart-pointer of the HiddenLineAttributeControl source. More...
HiddenLineAttributeControl &	SetAlgorithm (HiddenLine::Algorithm in_algorithm)
	Specifies the sorting algorithm that should be used to sort faces that have been made visible by the SetRenderFaces method. More...
HiddenLineAttributeControl &	SetColor (RGBAColor const &in_color)
	Sets the color to be applied to the hidden lines and markers. More...
HiddenLineAttributeControl &	SetDimFactor (float in_zero_to_one)
	Specifies the fraction of the current line color's R, G, and B channels to use for the color of hidden lines and markers. More...
HiddenLineAttributeControl &	SetFaceDisplacement (float in_buckets)
	Specifies how many units to push faces away from the camera. More...
HiddenLineAttributeControl &	SetLinePattern (char const *in_pattern)
	Specifies the pattern of the hidden lines. More...
HiddenLineAttributeControl &	SetLineSorting (bool in_on, float in_activation_weight=2, Line::SizeUnits in_units=Line::SizeUnits::Pixels)
	Species whether hidden lines are sorted, and if so, what the threshold for sorting is. More...
HiddenLineAttributeControl &	SetRenderFaces (bool in_state)
	Specifies whether triangles will be displayed during a hidden-line rendering. More...
HiddenLineAttributeControl &	SetRenderText (bool in_state)
	Specifies whether text will be displayed during a hidden-line rendering. More...
HiddenLineAttributeControl &	SetSilhouetteCleanup (bool in_state)
	Silhouette edges can show unpleasant "fishtail" patterns at points on smooth surfaces where curvature in one orientation is very different from the curvature in another (e.g. More...
HiddenLineAttributeControl &	SetTransparencyCutoff (float in_zero_to_one)
	Specifies the threshold for when transparent objects are considered opaque. More...
HiddenLineAttributeControl &	SetVisibility (bool in_state)
	Specifies whether hidden lines and markers should be displayed. More...
HiddenLineAttributeControl &	SetWeight (float in_weight, Line::SizeUnits in_units=Line::SizeUnits::ScaleFactor)
	Sets the weight of lines drawn in hidden line rendering. More...
HiddenLineAttributeControl &	UnsetAlgorithm ()
	Removes the hidden line algorithm setting. More...
HiddenLineAttributeControl &	UnsetColor ()
	Removes the hidden line color setting. More...
HiddenLineAttributeControl &	UnsetDimFactor ()
	Removes the dim factor setting. More...
HiddenLineAttributeControl &	UnsetFaceDisplacement ()
	Removes the face displacement setting. More...
HiddenLineAttributeControl &	UnsetLinePattern ()
	Removes the line pattern setting for hidden lines. More...
HiddenLineAttributeControl &	UnsetLineSorting ()
	Removes the line sorting settings for hidden lines. More...
HiddenLineAttributeControl &	UnsetRenderFaces ()
	Removes the face rendering setting. More...
HiddenLineAttributeControl &	UnsetRenderText ()
	Removes the text rendering setting. More...
HiddenLineAttributeControl &	UnsetSilhouetteCleanup ()
	Removes the silhouette cleanup setting. More...
HiddenLineAttributeControl &	UnsetTransparencyCutoff ()
	Removes the transparency cutoff setting. More...
HiddenLineAttributeControl &	UnsetVisibility ()
	Removes the hidden line visibility setting. More...
HiddenLineAttributeControl &	UnsetWeight ()
	Removes the weight setting for hidden line. More...
HiddenLineAttributeControl &	UnsetEverything ()
	Removes all settings from this object. More...
bool	ShowAlgorithm (HiddenLine::Algorithm &out_algorithm) const
	Shows the algorithm to be used during hidden line rendering. More...
bool	ShowColor (RGBAColor &out_color) const
	Shows the color applied to hidden lines and markers. More...
bool	ShowDimFactor (float &out_zero_to_one) const
	Shows the dim factor multiplier applied to each channel of the hidden line color. More...
bool	ShowFaceDisplacement (float &out_buckets) const
	Shows the number of units to push faces away from the camera. More...
bool	ShowLinePattern (UTF8 &out_pattern) const
	Shows the pattern of the hidden lines. More...
bool	ShowLineSorting (bool &out_state, float &out_threshold, Line::SizeUnits &out_units) const
	Shows the hidden line sorting options. More...
bool	ShowRenderFaces (bool &out_state) const
	Shows whether triangles will be displayed during a hidden-line rendering. More...
bool	ShowRenderText (bool &out_state) const
	Shows whether text will be displayed during a hidden-line rendering. More...
bool	ShowSilhouetteCleanup (bool &out_state) const
	Shows whether hidden line rendering should be post-processed to remove visual artifacts of silhouette edges. More...
bool	ShowTransparencyCutoff (float &out_zero_to_one) const
	Shows the threshold for when transparent objects are considered opaque. More...
bool	ShowVisibility (bool &out_state) const
	Shows whether hidden lines and markers should be displayed. More...
bool	ShowWeight (float &out_weight, Line::SizeUnits &out_units) const
	Shows the weight of lines drawn in hidden line rendering. 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::HiddenLineAttributeControl

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

Detailed Description

The HPS::HiddenLineAttributeControl class is a smart pointer that is tied to a database object. This control allows you to manipulate the various attributes associated with hidden lines. Hidden line is a rendering mode that applies to the scene as a whole. You should not set disparate hidden line attributes in your scene.

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

Constructor & Destructor Documentation

HiddenLineAttributeControl() [1/4]

HPS::HiddenLineAttributeControl::HiddenLineAttributeControl ( SegmentKey &  in_seg )

explicit

Initializes a control tied to the segment in_seg.

HiddenLineAttributeControl() [2/4]

HPS::HiddenLineAttributeControl::HiddenLineAttributeControl

(

HiddenLineAttributeControl const &

in_that

)

Initializes a control tied to the same object as in_that.

HiddenLineAttributeControl() [3/4]

HPS::HiddenLineAttributeControl::HiddenLineAttributeControl

(

HiddenLineAttributeControl &&

in_that

)

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

Parameters

in_that

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

~HiddenLineAttributeControl()

HPS::HiddenLineAttributeControl::~HiddenLineAttributeControl

(

)

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

HiddenLineAttributeControl() [4/4]

HPS::HiddenLineAttributeControl::HiddenLineAttributeControl ( )

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::HiddenLineAttributeControl::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Control.

operator=() [1/2]

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::operator=

(

HiddenLineAttributeControl &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this HiddenLineAttributeKit.

operator=() [2/2]

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::operator=

(

HiddenLineAttributeControl const &

in_that

)

Share the underlying smart-pointer of the HiddenLineAttributeControl source.

Parameters

in_that

The HiddenLineAttributeControl source of the assignment.

Returns

A reference to this HiddenLineAttributeControl.

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.

SetAlgorithm()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetAlgorithm

(

HiddenLine::Algorithm

in_algorithm

)

Specifies the sorting algorithm that should be used to sort faces that have been made visible by the SetRenderFaces method.

Default is ZBuffer.

Parameters

in_algorithm

The algorithm used to sort visible faces.

Returns

A reference to this object.

SetColor()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetColor

(

RGBAColor const &

in_color

)

Sets the color to be applied to the hidden lines and markers.

Parameters

in_color

The color hidden line geometry should be drawn in.

Returns

A reference to this object.

SetDimFactor()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetDimFactor

(

float

in_zero_to_one

)

Specifies the fraction of the current line color's R, G, and B channels to use for the color of hidden lines and markers.

By default, Visualize will automatically take a fraction of the RGB values to darken the hidden lines and markers.

Parameters

in_zero_to_one

A multiplier, between [0,1], applied to each channel of the hidden line color.

Returns

A reference to this object.

SetFaceDisplacement()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetFaceDisplacement

(

float

in_buckets

)

Specifies how many units to push faces away from the camera.

This can help improve hidden line scene quality if distinct polylines/lines are being used to denote user-defined edges on shell/mesh regions, but are not exactly coincident with the actual shell/mesh edges. Note: hidden line face displacement is separate from the general face displacement value set with the DrawingAttributeKit::SetFaceDisplacement.

Parameters

in_buckets

The number of units to move faces in the Z-Buffer. The units are 1/2^24 in the normalized depth range [0,1]. Negative values will move faces toward the camera, positive values away from the camera.

Returns

A reference to this object.

See also

DrawingAttributeKit::SetFaceDisplacement()

SetLinePattern()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetLinePattern

(

char const *

in_pattern

)

Specifies the pattern of the hidden lines.

Parameters

in_pattern

The name of a line pattern, defined in a portfolio that is accessible.

Returns

A reference to this object.

SetLineSorting()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetLineSorting	(	bool	in_on,
		float	in_activation_weight = 2,
		Line::SizeUnits	in_units = Line::SizeUnits::Pixels
	)

Species whether hidden lines are sorted, and if so, what the threshold for sorting is.

If Hidden Line Sorting is activated, lines will be draw in proper z-order.If this option is not activated, the order in which lines are drawn is non-deterministic. Enabling this option will result in slower performance. Due to the poor performance, this option is not recommended for screen drawing. However, it may be useful for hardcopy export. Use the functions HPS::Hardcopy::GDI::ExportOptionsKit::SetHiddenLineSorting() or HPS::Hardcopy::File::ExportOptionsKit::SetHiddenLineSorting() to enable this option for hardcopy export.

Parameters

in_on	Whether to sort or not.
in_activation_weight	Lines thicker than this will be sorted. Thinner ones will be ignored.
in_units	Units applied to in_activation_weight.

Returns

A reference to this object.

SetRenderFaces()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetRenderFaces

(

bool

in_state

)

Specifies whether triangles will be displayed during a hidden-line rendering.

Parameters

in_state

Whether triangles will displayed during a hidden-line rendering.

Returns

A reference to this object.

SetRenderText()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetRenderText

(

bool

in_state

)

Specifies whether text will be displayed during a hidden-line rendering.

Parameters

in_state

Whether text will displayed during a hidden-line rendering.

Returns

A reference to this object.

SetSilhouetteCleanup()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetSilhouetteCleanup

(

bool

in_state

)

Silhouette edges can show unpleasant "fishtail" patterns at points on smooth surfaces where curvature in one orientation is very different from the curvature in another (e.g.

the inside of a torus). Silhouette cleanup causes a post-process to remove most of these patterns.

Parameters

in_state

Whether hidden line rendering should be post-processed to remove visual artifacts.

Returns

A reference to this object.

SetTransparencyCutoff()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetTransparencyCutoff

(

float

in_zero_to_one

)

Specifies the threshold for when transparent objects are considered opaque.

Objects with transparency greater than the cutoff will be considered opaque while objects with transparency less than the cutoff will treated as transparent.

Parameters

in_zero_to_one

The cutoff value, between [0,1].

Returns

A reference to this object.

SetVisibility()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetVisibility

(

bool

in_state

)

Specifies whether hidden lines and markers should be displayed.

Parameters

in_state

The algorithm to be used during hidden line rendering.

Returns

A reference to this object.

SetWeight()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetWeight	(	float	in_weight,
		Line::SizeUnits	in_units = Line::SizeUnits::ScaleFactor
	)

Sets the weight of lines drawn in hidden line rendering.

Parameters

in_weight	The weight value for hidden lines.
in_units	The units applied to in_weight.

Returns

A reference to this object.

ShowAlgorithm()

bool HPS::HiddenLineAttributeControl::ShowAlgorithm

(

HiddenLine::Algorithm &

out_algorithm

)

const

Shows the algorithm to be used during hidden line rendering.

Parameters

out_algorithm

The algorithm used for hidden line rendering.

Returns

true if the setting is valid, false otherwise.

ShowColor()

bool HPS::HiddenLineAttributeControl::ShowColor

(

RGBAColor &

out_color

)

const

Shows the color applied to hidden lines and markers.

Parameters

out_color

The color of hidden line geometry.

Returns

true if the setting is valid, false otherwise.

ShowDimFactor()

bool HPS::HiddenLineAttributeControl::ShowDimFactor

(

float &

out_zero_to_one

)

const

Shows the dim factor multiplier applied to each channel of the hidden line color.

Parameters

out_zero_to_one

A multiplier, between [0,1], applied to each channel of the hidden line color.

Returns

true if the setting is valid, false otherwise.

ShowFaceDisplacement()

bool HPS::HiddenLineAttributeControl::ShowFaceDisplacement

(

float &

out_buckets

)

const

Shows the number of units to push faces away from the camera.

Parameters

out_buckets

The number of "z buckets" to push faces away from the camera.

Returns

true if the setting is valid, false otherwise.

ShowLinePattern()

bool HPS::HiddenLineAttributeControl::ShowLinePattern

(

UTF8 &

out_pattern

)

const

Shows the pattern of the hidden lines.

Parameters

out_pattern

The name of a line pattern, defined in a portfolio that is accessible.

Returns

true if the setting is valid, false otherwise.

ShowLineSorting()

bool HPS::HiddenLineAttributeControl::ShowLineSorting	(	bool &	out_state,
		float &	out_threshold,
		Line::SizeUnits &	out_units
	)		const

Shows the hidden line sorting options.

Parameters

out_state	Whether hidden line sorting is on or off.
out_threshold	The minimum width at which hidden lines are sorted.
out_units	The units that out_threshold is measured in.

Returns

true if the setting is valid, false otherwise.

ShowRenderFaces()

bool HPS::HiddenLineAttributeControl::ShowRenderFaces

(

bool &

out_state

)

const

Shows whether triangles will be displayed during a hidden-line rendering.

Parameters

out_state

Whether triangles will displayed during a hidden-line rendering.

Returns

true if the setting is valid, false otherwise.

ShowRenderText()

bool HPS::HiddenLineAttributeControl::ShowRenderText

(

bool &

out_state

)

const

Shows whether text will be displayed during a hidden-line rendering.

Parameters

out_state

Whether text will displayed during a hidden-line rendering.

Returns

true if the setting is valid, false otherwise.

ShowSilhouetteCleanup()

bool HPS::HiddenLineAttributeControl::ShowSilhouetteCleanup

(

bool &

out_state

)

const

Shows whether hidden line rendering should be post-processed to remove visual artifacts of silhouette edges.

Parameters

out_state

Whether hidden line rendering should be post-processed to remove visual artifacts.

Returns

true if the setting is valid, false otherwise.

ShowTransparencyCutoff()

bool HPS::HiddenLineAttributeControl::ShowTransparencyCutoff

(

float &

out_zero_to_one

)

const

Shows the threshold for when transparent objects are considered opaque.

Parameters

out_zero_to_one

The cutoff value, between [0,1].

Returns

true if the setting is valid, false otherwise.

ShowVisibility()

bool HPS::HiddenLineAttributeControl::ShowVisibility

(

bool &

out_state

)

const

Shows whether hidden lines and markers should be displayed.

Parameters

out_state

Whether hidden lines and markers should be displayed.

Returns

true if the setting is valid, false otherwise.

ShowWeight()

bool HPS::HiddenLineAttributeControl::ShowWeight	(	float &	out_weight,
		Line::SizeUnits &	out_units
	)		const

Shows the weight of lines drawn in hidden line rendering.

Parameters

out_weight	The weight value for hidden lines.
out_units	The units applied to in_weight.

Returns

true if the setting is valid, false otherwise.

Type()

virtual HPS::Type HPS::HiddenLineAttributeControl::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.

UnsetAlgorithm()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::UnsetAlgorithm

(

)

Removes the hidden line algorithm setting.

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

Returns

A reference to this object.

UnsetColor()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::UnsetColor

(

)

Removes the hidden line color setting.

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

Returns

A reference to this object.

UnsetDimFactor()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::UnsetDimFactor

(

)

Removes the dim factor setting.

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

Returns

A reference to this object.

UnsetEverything()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::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 HiddenLineAttributeKit::GetDefault().

Returns

A reference to this object.

UnsetFaceDisplacement()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::UnsetFaceDisplacement

(

)

Removes the face displacement setting.

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

Returns

A reference to this object.

UnsetLinePattern()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::UnsetLinePattern

(

)

Removes the line pattern setting for hidden lines.

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

Returns

A reference to this object.

UnsetLineSorting()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::UnsetLineSorting

(

)

Removes the line sorting settings for hidden lines.

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

Returns

A reference to this object.

UnsetRenderFaces()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::UnsetRenderFaces

(

)

Removes the face rendering setting.

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

Returns

A reference to this object.

UnsetRenderText()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::UnsetRenderText

(

)

Removes the text rendering setting.

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

Returns

A reference to this object.

UnsetSilhouetteCleanup()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::UnsetSilhouetteCleanup

(

)

Removes the silhouette cleanup setting.

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

Returns

A reference to this object.

UnsetTransparencyCutoff()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::UnsetTransparencyCutoff

(

)

Removes the transparency cutoff setting.

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

Returns

A reference to this object.

UnsetVisibility()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::UnsetVisibility

(

)

Removes the hidden line visibility setting.

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

Returns

A reference to this object.

UnsetWeight()

HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::UnsetWeight

(

)

Removes the weight setting for hidden line.

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

Returns

A reference to this object.

Member Data Documentation

staticType

const HPS::Type HPS::HiddenLineAttributeControl::staticType = HPS::Type::HiddenLineAttributeControl

static

---

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

• hps.h