HPS::UpdateOptionsControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::UpdateOptionsControl:

Collaboration diagram for HPS::UpdateOptionsControl:

Public Member Functions
	UpdateOptionsControl (WindowKey const &in_window)
	This constructor creates a UpdateOptionsControl object which is tied to the specified window. More...
	UpdateOptionsControl (UpdateOptionsControl const &in_that)
	The copy constructor creates a UpdateOptionsControl object that shares the underlying smart-pointer of the source UpdateOptionsControl. More...
	UpdateOptionsControl (UpdateOptionsControl &&in_that)
	The move constructor creates a UpdateOptionsControl by transferring the underlying impl of the rvalue reference to this UpdateOptionsControl thereby avoiding a copy and allocation. More...
UpdateOptionsControl &	operator= (UpdateOptionsControl &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this UpdateOptionsControl thereby avoiding a copy. More...
	~UpdateOptionsControl ()
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
HPS::Type	ObjectType () const
UpdateOptionsControl &	operator= (UpdateOptionsControl const &in_that)
	Share the underlying smart-pointer of the UpdateOptionsControl source. More...
UpdateOptionsControl &	SetUpdateType (HPS::Window::UpdateType in_type)
	Sets the type of update of this UpdateOptionsControl. More...
UpdateOptionsControl &	SetTimeLimit (HPS::Time in_time_limit)
	Sets the time limit of this UpdateOptionsControl. More...
UpdateOptionsControl &	UnsetUpdateType ()
	Removes the type of control for this update Control. More...
UpdateOptionsControl &	UnsetTimeLimit ()
	Removes the time limit of this UpdateOptionsControl. More...
UpdateOptionsControl &	UnsetEverything ()
	Removes all settings from this UpdateOptionsControl. More...
bool	ShowUpdateType (HPS::Window::UpdateType &out_type) const
	Shows the type of control from this UpdateOptionsControl. More...
bool	ShowTimeLimit (HPS::Time &out_time_limit) const
	Shows the time limit from this UpdateOptionsControl. 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::UpdateOptionsControl

Private Member Functions
	UpdateOptionsControl ()
	Private default constructor to prevent instantiation without a window. More...

Detailed Description

The HPS::UpdateOptionsControl class is a smart pointer that is tied to a database object. It is used to set selection related options on a HPS::WindowKey. Options include the selection algorithm, granularity, internal limit, related limit, level, proximity, and sorting.

Default values for the various fields of HPS::UpdateOptionsControl can be found here.

Constructor & Destructor Documentation

UpdateOptionsControl() [1/4]

HPS::UpdateOptionsControl::UpdateOptionsControl ( WindowKey const &  in_window )

explicit

This constructor creates a UpdateOptionsControl object which is tied to the specified window.

Parameters

in_window

The window which this UpdateOptionsControl should operate on.

UpdateOptionsControl() [2/4]

HPS::UpdateOptionsControl::UpdateOptionsControl

(

UpdateOptionsControl const &

in_that

)

The copy constructor creates a UpdateOptionsControl object that shares the underlying smart-pointer of the source UpdateOptionsControl.

Parameters

in_that

The source UpdateOptionsControl to copy.

UpdateOptionsControl() [3/4]

HPS::UpdateOptionsControl::UpdateOptionsControl

(

UpdateOptionsControl &&

in_that

)

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

Parameters

in_that

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

~UpdateOptionsControl()

HPS::UpdateOptionsControl::~UpdateOptionsControl

(

)

UpdateOptionsControl() [4/4]

HPS::UpdateOptionsControl::UpdateOptionsControl ( )

private

Private default constructor to prevent instantiation without a window.

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

inlinevirtual

Reimplemented from HPS::Control.

operator=() [1/2]

UpdateOptionsControl& HPS::UpdateOptionsControl::operator=

(

UpdateOptionsControl &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this UpdateOptionsControl.

operator=() [2/2]

UpdateOptionsControl& HPS::UpdateOptionsControl::operator=

(

UpdateOptionsControl const &

in_that

)

Share the underlying smart-pointer of the UpdateOptionsControl source.

Parameters

in_that

The UpdateOptionsControl source of the assignment.

Returns

A reference to this UpdateOptionsControl.

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.

SetTimeLimit()

UpdateOptionsControl& HPS::UpdateOptionsControl::SetTimeLimit

(

HPS::Time

in_time_limit

)

Sets the time limit of this UpdateOptionsControl.

Parameters

in_time_limit

The time limit for this UpdateOptionsControl update.

Returns

A reference to this UpdateOptionsControl.

SetUpdateType()

UpdateOptionsControl& HPS::UpdateOptionsControl::SetUpdateType

(

HPS::Window::UpdateType

in_type

)

Sets the type of update of this UpdateOptionsControl.

Parameters

in_type

The type of update that this UpdateOptionsControl will perform.

Returns

A reference to this UpdateOptionsControl.

ShowTimeLimit()

bool HPS::UpdateOptionsControl::ShowTimeLimit

(

HPS::Time &

out_time_limit

)

const

Shows the time limit from this UpdateOptionsControl.

Parameters

out_proximity

The selection proximity.

Returns

true if the time limit is valid, false otherwise.

ShowUpdateType()

bool HPS::UpdateOptionsControl::ShowUpdateType

(

HPS::Window::UpdateType &

out_type

)

const

Shows the type of control from this UpdateOptionsControl.

Parameters

out_type

The type of update.

Returns

true if the type is valid, false otherwise.

Type()

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

UnsetEverything()

UpdateOptionsControl& HPS::UpdateOptionsControl::UnsetEverything

(

)

Removes all settings from this UpdateOptionsControl.

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

Returns

A reference to this UpdateOptionsControl.

UnsetTimeLimit()

UpdateOptionsControl& HPS::UpdateOptionsControl::UnsetTimeLimit

(

)

Removes the time limit of this UpdateOptionsControl.

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

Returns

A reference to this UpdateOptionsControl.

UnsetUpdateType()

UpdateOptionsControl& HPS::UpdateOptionsControl::UnsetUpdateType

(

)

Removes the type of control for this update Control.

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

Returns

A reference to this UpdateOptionsControl.

Member Data Documentation

staticType

const HPS::Type HPS::UpdateOptionsControl::staticType = HPS::Type::UpdateOptionsControl

static

---

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

• hps.h