HPS::DebuggingControl Class Reference

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

#include <hps.h>

Inheritance diagram for HPS::DebuggingControl:

Collaboration diagram for HPS::DebuggingControl:

Public Member Functions
	DebuggingControl (WindowKey &in_window)
	Initializes a control tied to the window segment in_window. More...
	DebuggingControl (DebuggingControl const &in_that)
	Initializes a control tied to the same object as in_that. More...
	DebuggingControl (DebuggingControl &&in_that)
	The move constructor creates a DebuggingControl by transferring the underlying impl of the rvalue reference to this DebuggingControl thereby avoiding a copy and allocation. More...
DebuggingControl &	operator= (DebuggingControl &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this DebuggingControl thereby avoiding a copy. More...
	~DebuggingControl ()
	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
DebuggingControl &	operator= (DebuggingControl const &in_that)
	Share the underlying smart-pointer of the DebuggingControl source. More...
DebuggingControl &	SetResourceMonitor (bool in_display)
	Controls whether a small window will be drawn displaying a number of statistics about the last update. More...
DebuggingControl &	UnsetResourceMonitor ()
	Unsets the Resource Monitor setting for this control. More...
DebuggingControl &	UnsetEverything ()
	Removes all settings from this object. More...
bool	ShowResourceMonitor (bool &out_display) const
	Shows the resource monitor setting. 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::DebuggingControl

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

Detailed Description

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

Using this control, you are able to set and show the resource monitor. This control is only accessible from a HPS::WindowKey. This table lists default values for the various segment attributes accessible from HPS::DebuggingControl.

Constructor & Destructor Documentation

DebuggingControl() [1/4]

HPS::DebuggingControl::DebuggingControl ( WindowKey &  in_window )

explicit

Initializes a control tied to the window segment in_window.

DebuggingControl() [2/4]

HPS::DebuggingControl::DebuggingControl

(

DebuggingControl const &

in_that

)

Initializes a control tied to the same object as in_that.

DebuggingControl() [3/4]

HPS::DebuggingControl::DebuggingControl

(

DebuggingControl &&

in_that

)

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

Parameters

in_that

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

~DebuggingControl()

HPS::DebuggingControl::~DebuggingControl

(

)

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

DebuggingControl() [4/4]

HPS::DebuggingControl::DebuggingControl ( )

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

inlinevirtual

Reimplemented from HPS::Control.

operator=() [1/2]

DebuggingControl& HPS::DebuggingControl::operator=

(

DebuggingControl &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this DebuggingControl.

operator=() [2/2]

DebuggingControl& HPS::DebuggingControl::operator=

(

DebuggingControl const &

in_that

)

Share the underlying smart-pointer of the DebuggingControl source.

Parameters

in_that

The DebuggingControl source of the assignment.

Returns

A reference to this DebuggingControl.

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.

SetResourceMonitor()

DebuggingControl& HPS::DebuggingControl::SetResourceMonitor

(

bool

in_display

)

Controls whether a small window will be drawn displaying a number of statistics about the last update.

Parameters

in_display

Whether a small window will be drawn displaying a number of statistics about the last update.

Returns

A reference to this object.

See also

Resource monitor default value.

ShowResourceMonitor()

bool HPS::DebuggingControl::ShowResourceMonitor

(

bool &

out_display

)

const

Shows the resource monitor setting.

Parameters

out_display

Whether a small window will be drawn displaying a number of statistics about the last update.

Returns

true if the setting is valid, false otherwise.

Type()

virtual HPS::Type HPS::DebuggingControl::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()

DebuggingControl& HPS::DebuggingControl::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 DebuggingKit::GetDefault().

Returns

A reference to this object.

UnsetResourceMonitor()

DebuggingControl& HPS::DebuggingControl::UnsetResourceMonitor

(

)

Unsets the Resource Monitor setting for this control.

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

Returns

A reference to this object.

Member Data Documentation

staticType

const HPS::Type HPS::DebuggingControl::staticType = HPS::Type::DebuggingControl

static

---

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

• hps.h