HPS::CuttingSectionAttributeControl Class Reference

The HPS::CuttingSectionAttributeControl class is a smart pointer that is tied to a database object. More...

#include <hps.h>

Inheritance diagram for HPS::CuttingSectionAttributeControl:

Collaboration diagram for HPS::CuttingSectionAttributeControl:

Public Member Functions
	CuttingSectionAttributeControl (SegmentKey &in_seg)
	Initializes a control tied to the segment in_seg. More...
	CuttingSectionAttributeControl (CuttingSectionAttributeControl const &in_that)
	Initializes a control tied to the same object as in_that. More...
	CuttingSectionAttributeControl (CuttingSectionAttributeControl &&in_that)
	The move constructor creates a CuttingSectionAttributeControl by transferring the underlying impl of the rvalue reference to this CuttingSectionAttributeControl thereby avoiding a copy and allocation. More...
CuttingSectionAttributeControl &	operator= (CuttingSectionAttributeControl &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this CuttingSectionAttributeControl thereby avoiding a copy. More...
	~CuttingSectionAttributeControl ()
	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
CuttingSectionAttributeControl &	operator= (CuttingSectionAttributeControl const &in_that)
	Share the underlying smart-pointer of the CuttingSectionAttributeControl source. More...
CuttingSectionAttributeControl &	SetEdgeWeight (float in_weight, Line::SizeUnits in_units=Line::SizeUnits::ScaleFactor)
	Sets the cut edge weight. More...
CuttingSectionAttributeControl &	SetTolerance (float in_tolerance, CuttingSection::ToleranceUnits in_units)
	Sets the tolerance for closing loops when processing capping faces. More...
CuttingSectionAttributeControl &	SetCuttingLevel (CuttingSection::CuttingLevel in_level)
	Sets the cutting section cutting level. More...
CuttingSectionAttributeControl &	SetCappingLevel (CuttingSection::CappingLevel in_level)
	Sets the cutting section capping level. More...
CuttingSectionAttributeControl &	SetMaterialPreference (CuttingSection::MaterialPreference in_preference)
	Sets the material preference for cut geometry. More...
CuttingSectionAttributeControl &	UnsetEdgeWeight ()
	Removes the cutting section cut edge weight setting. More...
CuttingSectionAttributeControl &	UnsetTolerance ()
	Removes the cutting section capping tolerance setting. More...
CuttingSectionAttributeControl &	UnsetCuttingLevel ()
	Removes the cutting section cutting level setting. More...
CuttingSectionAttributeControl &	UnsetCappingLevel ()
	Removes the cutting section capping level setting. More...
CuttingSectionAttributeControl &	UnsetMaterialPreference ()
	Removes the material preference for cut geometry setting. More...
CuttingSectionAttributeControl &	UnsetEverything ()
	Removes all settings from this object. More...
bool	ShowCuttingLevel (CuttingSection::CuttingLevel &out_level) const
	Shows the cutting section cutting level setting. More...
bool	ShowCappingLevel (CuttingSection::CappingLevel &out_level) const
	Shows the cutting section capping level setting. More...
bool	ShowMaterialPreference (CuttingSection::MaterialPreference &out_preference) const
	Shows the orientation of colors and radii of cylinders. More...
bool	ShowEdgeWeight (float &out_weight, Line::SizeUnits &out_units) const
	Shows the weight of cut edges. More...
bool	ShowTolerance (float &out_tolerance, CuttingSection::ToleranceUnits &out_units) const
	Shows the tolerance for closing loops when processing capping faces. 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::CuttingSectionAttributeControl

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

Detailed Description

The HPS::CuttingSectionAttributeControl class is a smart pointer that is tied to a database object.

This object is used to manipulate the various cutting section attributes. This table lists default values for the various segment attributes accessible from HPS::CuttingSectionAttributeControl.

Constructor & Destructor Documentation

CuttingSectionAttributeControl() [1/4]

HPS::CuttingSectionAttributeControl::CuttingSectionAttributeControl ( SegmentKey &  in_seg )

explicit

Initializes a control tied to the segment in_seg.

CuttingSectionAttributeControl() [2/4]

HPS::CuttingSectionAttributeControl::CuttingSectionAttributeControl

(

CuttingSectionAttributeControl const &

in_that

)

Initializes a control tied to the same object as in_that.

CuttingSectionAttributeControl() [3/4]

HPS::CuttingSectionAttributeControl::CuttingSectionAttributeControl

(

CuttingSectionAttributeControl &&

in_that

)

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

Parameters

in_that

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

~CuttingSectionAttributeControl()

HPS::CuttingSectionAttributeControl::~CuttingSectionAttributeControl

(

)

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

CuttingSectionAttributeControl() [4/4]

HPS::CuttingSectionAttributeControl::CuttingSectionAttributeControl ( )

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

inlinevirtual

Reimplemented from HPS::Control.

operator=() [1/2]

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::operator=

(

CuttingSectionAttributeControl &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this CuttingSectionAttributeControl.

operator=() [2/2]

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::operator=

(

CuttingSectionAttributeControl const &

in_that

)

Share the underlying smart-pointer of the CuttingSectionAttributeControl source.

Parameters

in_that

The CuttingSectionAttributeControl source of the assignment.

Returns

A reference to this CuttingSectionAttributeControl.

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.

SetCappingLevel()

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::SetCappingLevel

(

CuttingSection::CappingLevel

in_level

)

Sets the cutting section capping level.

Parameters

in_level

The cutting section capping level.

Returns

A reference to this object.

SetCuttingLevel()

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::SetCuttingLevel

(

CuttingSection::CuttingLevel

in_level

)

Sets the cutting section cutting level.

Parameters

in_level

The cutting section cutting level.

Returns

A reference to this object.

SetEdgeWeight()

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::SetEdgeWeight	(	float	in_weight,
		Line::SizeUnits	in_units = Line::SizeUnits::ScaleFactor
	)

Sets the cut edge weight.

Parameters

in_weight	The edge weight to apply for cut edges.
in_units	The units of the weight given.

Returns

A reference to this object.

SetMaterialPreference()

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::SetMaterialPreference

(

CuttingSection::MaterialPreference

in_preference

)

Sets the material preference for cut geometry.

Parameters

in_preference

The material preference for cut geometry.

Returns

A reference to this object.

SetTolerance()

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::SetTolerance	(	float	in_tolerance,
		CuttingSection::ToleranceUnits	in_units
	)

Sets the tolerance for closing loops when processing capping faces.

Parameters

in_tolerance	The tolerance to use.
in_units	How to interpret the given tolerance.

Returns

A reference to this object.

ShowCappingLevel()

bool HPS::CuttingSectionAttributeControl::ShowCappingLevel

(

CuttingSection::CappingLevel &

out_level

)

const

Shows the cutting section capping level setting.

Parameters

out_level

The cutting section capping level.

Returns

true if a cutting section capping level setting was specified, false otherwise.

ShowCuttingLevel()

bool HPS::CuttingSectionAttributeControl::ShowCuttingLevel

(

CuttingSection::CuttingLevel &

out_level

)

const

Shows the cutting section cutting level setting.

Parameters

out_level

The cutting section cutting level.

Returns

true if a cutting section cutting level setting was specified, false otherwise.

ShowEdgeWeight()

bool HPS::CuttingSectionAttributeControl::ShowEdgeWeight	(	float &	out_weight,
		Line::SizeUnits &	out_units
	)		const

Shows the weight of cut edges.

Parameters

out_weight	The weight value for cut edges.
out_units	The units applied to in_weight.

Returns

true if the setting is valid, false otherwise.

ShowMaterialPreference()

bool HPS::CuttingSectionAttributeControl::ShowMaterialPreference

(

CuttingSection::MaterialPreference &

out_preference

)

const

Shows the orientation of colors and radii of cylinders.

Parameters

out_preference

The material preference for cut geometry.

Returns

true if a material preference for cut geometry was specified, false otherwise.

ShowTolerance()

bool HPS::CuttingSectionAttributeControl::ShowTolerance	(	float &	out_tolerance,
		CuttingSection::ToleranceUnits &	out_units
	)		const

Shows the tolerance for closing loops when processing capping faces.

Parameters

out_tolerance	The tolerance to use.
out_units	The units for the tolerance.

Returns

true if the setting is valid, false otherwise.

Type()

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

UnsetCappingLevel()

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::UnsetCappingLevel

(

)

Removes the cutting section capping level setting.

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

Returns

A reference to this object.

UnsetCuttingLevel()

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::UnsetCuttingLevel

(

)

Removes the cutting section cutting level setting.

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

Returns

A reference to this object.

UnsetEdgeWeight()

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::UnsetEdgeWeight

(

)

Removes the cutting section cut edge weight setting.

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

Returns

A reference to this object.

UnsetEverything()

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::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 CuttingSectionAttributeKit::GetDefault().

Returns

A reference to this object.

UnsetMaterialPreference()

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::UnsetMaterialPreference

(

)

Removes the material preference for cut geometry setting.

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

Returns

A reference to this object.

UnsetTolerance()

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::UnsetTolerance

(

)

Removes the cutting section capping tolerance setting.

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

Returns

A reference to this object.

Member Data Documentation

staticType

const HPS::Type HPS::CuttingSectionAttributeControl::staticType = HPS::Type::CuttingSectionAttributeControl

static

---

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

• hps.h