HPS::OperatorControl Class Reference

The OperatorControl class is a smart pointer that is tied to a database object. More...

#include <sprk.h>

Inheritance diagram for HPS::OperatorControl:

Collaboration diagram for HPS::OperatorControl:

Public Member Functions
	OperatorControl (View const &in_view)
	Initializes a control tied to the view in_view. More...
	OperatorControl (OperatorControl const &in_that)
	Initializes a control tied to the same object as in_that. More...
	OperatorControl (OperatorControl &&in_that)
	The move constructor creates a OperatorControl by transferring the underlying impl of the rvalue reference to this OperatorControl thereby avoiding a copy and allocation. More...
OperatorControl &	operator= (OperatorControl &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this OperatorControl thereby avoiding a copy. More...
	~OperatorControl ()
	Releases a reference to the database object this control is tied to. More...
HPS::Type	ObjectType () const
OperatorControl &	operator= (OperatorControl const &in_that)
	Share the smart-pointer. More...
size_t	GetCount ()
	Returns the number of operators in use here. More...
size_t	GetCount (Operator::Priority in_priority)
	Returns the number of operators of the specified priority in use here. More...
OperatorControl &	Push (OperatorPtr const &in_operator, Operator::Priority in_priority=Operator::Priority::Default)
	Adds an operator to the top of the operator stack within its priority and assumes control of its memory. More...
OperatorControl &	Push (Operator *in_operator, Operator::Priority in_priority=Operator::Priority::Default)
	Adds an operator to the top of the operator stack within its priority and assumes control of its memory. More...
bool	Pop (Operator::Priority in_priority=Operator::Priority::Default)
	Removes the top operator from the operator stack of the specified priority and frees the memory associated with it. More...
bool	Pop (OperatorPtr &out_operator)
	Removes the top operator from the Normal priority operator stack and passes a handle to it to the user. More...
bool	Pop (Operator::Priority in_priority, OperatorPtr &out_operator)
	Removes the top operator from the operator stack of the specified priority and passes a handle to it to the user. More...
OperatorControl &	Set (OperatorPtr const &in_operator, Operator::Priority in_priority=Operator::Priority::Default)
	Sets an operator as the only operator in use of the specified priority and assumes control of its memory. More...
OperatorControl &	Set (Operator *in_operator, Operator::Priority in_priority=Operator::Priority::Default)
	Sets an operator as the only operator in use of the specified priority and assumes control of its memory. More...
OperatorControl &	Set (OperatorPtrArray &in_operators, Operator::Priority in_priority=Operator::Priority::Default)
	Sets a collection of operators as the only operators in use of the specified priority and assumes control of their memory. More...
OperatorControl &	Set (size_t in_count, OperatorPtr in_operators [], Operator::Priority in_priority=Operator::Priority::Default)
	Sets a collection of operators as the only operators in use of the specified priority and assumes control of their memory. More...
OperatorControl &	UnsetTop (Operator::Priority in_priority=Operator::Priority::Default)
	Removes the top operator from the operator stack of the specified priority and frees the memory associated with it. More...
OperatorControl &	UnsetEverything (Operator::Priority in_priority)
	Removes all operators from the operator stack of the specified priority and frees the memory associated with them. More...
OperatorControl &	UnsetEverything ()
	Removes all operators from the operator stack of any priority and frees the memory associated with them. More...
bool	ShowTop (OperatorPtr &out_operator) const
	Shows the top operator on the Normal priority operator stack. More...
bool	ShowTop (Operator::Priority in_priority, OperatorPtr &out_operator) const
	Shows the top operator on the operator stack of the specified priority. More...
bool	Show (OperatorPtrArray &out_operators) const
	Shows all Normal priority operators in use on this segment. More...
bool	Show (Operator::Priority in_priority, OperatorPtrArray &out_operators) const
	Shows all operators in use on this segment of the specified priority. More...
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. 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::OperatorControl

Private Member Functions
	OperatorControl ()
	Private default constructor to prevent instantiation without a view. More...

Detailed Description

The OperatorControl class is a smart pointer that is tied to a database object.

This control allows you to add, remove, or otherwise manipulate operators associated with a view.

Constructor & Destructor Documentation

OperatorControl() [1/4]

HPS::OperatorControl::OperatorControl ( View const &  in_view )

explicit

Initializes a control tied to the view in_view.

OperatorControl() [2/4]

HPS::OperatorControl::OperatorControl

(

OperatorControl const &

in_that

)

Initializes a control tied to the same object as in_that.

OperatorControl() [3/4]

HPS::OperatorControl::OperatorControl

(

OperatorControl &&

in_that

)

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

Parameters

in_that

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

~OperatorControl()

HPS::OperatorControl::~OperatorControl

(

)

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

OperatorControl() [4/4]

HPS::OperatorControl::OperatorControl ( )

inlineprivate

Private default constructor to prevent instantiation without a view.

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.

GetCount() [1/2]

size_t HPS::OperatorControl::GetCount

(

)

Returns the number of operators in use here.

GetCount() [2/2]

size_t HPS::OperatorControl::GetCount

(

Operator::Priority

in_priority

)

Returns the number of operators of the specified priority in use here.

Parameters

in_priority

The priority of the operators to be counted.

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

inlinevirtual

Reimplemented from HPS::SprocketControl.

operator=() [1/2]

OperatorControl& HPS::OperatorControl::operator=

(

OperatorControl &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this OperatorControl.

operator=() [2/2]

OperatorControl& HPS::OperatorControl::operator=

(

OperatorControl const &

in_that

)

Share the smart-pointer.

Pop() [1/3]

bool HPS::OperatorControl::Pop

(

Operator::Priority

in_priority = Operator::Priority::Default

)

Removes the top operator from the operator stack of the specified priority and frees the memory associated with it.

Parameters

in_priority

The priority of the operator to be removed.

Returns

true if an operator was present, false otherwise.

Pop() [2/3]

bool HPS::OperatorControl::Pop

(

OperatorPtr &

out_operator

)

Removes the top operator from the Normal priority operator stack and passes a handle to it to the user.

The user is responsible for freeing memory associated with the operator.

Parameters

out_operator

A handle to the top operator, passed to the user.

Returns

true if an operator was present, false otherwise.

Pop() [3/3]

bool HPS::OperatorControl::Pop	(	Operator::Priority	in_priority,
		OperatorPtr &	out_operator
	)

Removes the top operator from the operator stack of the specified priority and passes a handle to it to the user.

The user is responsible for freeing memory associated with the operator.

Parameters

in_priority	The priority of the operator to be removed.
out_operator	A handle to the top operator, passed to the user.

Returns

true if an operator was present, false otherwise.

Push() [1/2]

OperatorControl& HPS::OperatorControl::Push	(	OperatorPtr const &	in_operator,
		Operator::Priority	in_priority = Operator::Priority::Default
	)

Adds an operator to the top of the operator stack within its priority and assumes control of its memory.

Existing operators in use are unmodified but operators on top get priority.

Parameters

in_operator	The operator to push to the top of the operator stack.
in_priority	The priority of the operator. All those with Low priority will be below all those with Normal priority which will, in turn, be below High priority operators.

Returns

A reference to this object.

Push() [2/2]

OperatorControl& HPS::OperatorControl::Push	(	Operator *	in_operator,
		Operator::Priority	in_priority = Operator::Priority::Default
	)

Adds an operator to the top of the operator stack within its priority and assumes control of its memory.

Existing operators in use are unmodified but operators on top get priority.

Deprecated:

It is recommended to use overloads which consume OperatorPtr as the object lifetime is simpler to reason about.

Parameters

in_operator	The operator to push to the top of the operator stack.
in_priority	The priority of the operator. All those with Low priority will be below all those with Normal priority which will, in turn, be below High priority operators.

Returns

A reference to this object.

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.

Set() [1/4]

OperatorControl& HPS::OperatorControl::Set	(	OperatorPtr const &	in_operator,
		Operator::Priority	in_priority = Operator::Priority::Default
	)

Sets an operator as the only operator in use of the specified priority and assumes control of its memory.

This replaces any existing operators of the same priority in use and frees the memory associated with them.

Parameters

in_operator	An operator to use on this view.
in_priority	The priority of the operator. All those with Low priority will be below all those with Normal priority which will, in turn, be below High priority operators.

Returns

A reference to this object.

Set() [2/4]

OperatorControl& HPS::OperatorControl::Set	(	Operator *	in_operator,
		Operator::Priority	in_priority = Operator::Priority::Default
	)

Sets an operator as the only operator in use of the specified priority and assumes control of its memory.

This replaces any existing operators in use and frees the memory associated with them.

Deprecated:

It is recommended to use overloads which consume OperatorPtr as the object lifetime is simpler to reason about.

Parameters

in_operator	An operator to use on this view.
in_priority	The priority of the operator. All those with Low priority will be below all those with Normal priority which will, in turn, be below High priority operators.

Returns

A reference to this object.

Set() [3/4]

OperatorControl& HPS::OperatorControl::Set	(	OperatorPtrArray &	in_operators,
		Operator::Priority	in_priority = Operator::Priority::Default
	)

Sets a collection of operators as the only operators in use of the specified priority and assumes control of their memory.

This replaces any existing operators in use and frees the memory associated with them.

Parameters

in_operators	An array of source operators to be used.
in_priority	The priority of the operators. All those with Low priority will be below all those with Normal priority which will, in turn, be below High priority operators.

Returns

A reference to this object.

Set() [4/4]

OperatorControl& HPS::OperatorControl::Set	(	size_t	in_count,
		OperatorPtr	in_operators[],
		Operator::Priority	in_priority = Operator::Priority::Default
	)

Sets a collection of operators as the only operators in use of the specified priority and assumes control of their memory.

This replaces any existing operators in use and frees the memory associated with them.

Parameters

in_count	The number of elements in the operator array.
in_operators	An array of source operators to be used.
in_priority	The priority of the operators. All those with Low priority will be below all those with Normal priority which will, in turn, be below High priority operators.

Returns

A reference to this object.

Show() [1/2]

bool HPS::OperatorControl::Show

(

OperatorPtrArray &

out_operators

)

const

Shows all Normal priority operators in use on this segment.

The operator stack is unmodified.

Parameters

out_operators

Handles to all Normal priority operators used by this View.

Returns

true if any operator was present, false otherwise.

Show() [2/2]

bool HPS::OperatorControl::Show	(	Operator::Priority	in_priority,
		OperatorPtrArray &	out_operators
	)		const

Shows all operators in use on this segment of the specified priority.

The operator stack is unmodified.

Parameters

in_priority	The priority of the operators to be shown.
out_operators	Handles to all operators of the specified priority used by this View.

Returns

true if any operator was present, false otherwise.

ShowTop() [1/2]

bool HPS::OperatorControl::ShowTop

(

OperatorPtr &

out_operator

)

const

Shows the top operator on the Normal priority operator stack.

The operator stack is unmodified.

Parameters

out_operator

The operator at the top of the operator stack

Returns

true if an operator was present, false otherwise.

ShowTop() [2/2]

bool HPS::OperatorControl::ShowTop	(	Operator::Priority	in_priority,
		OperatorPtr &	out_operator
	)		const

Shows the top operator on the operator stack of the specified priority.

The operator stack is unmodified.

Parameters

in_priority	The priority of the operator to be shown.
out_operator	The operator at the top of the operator stack

Returns

true if an operator was present, false otherwise.

Type()

virtual HPS::Type HPS::Object::Type ( ) const

virtualinherited

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 in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionOptionsControl, HPS::OffScreenWindowOptionsControl, HPS::ApplicationWindowOptionsControl, HPS::StandAloneWindowOptionsControl, HPS::AttributeLockControl, HPS::WindowInfoControl, HPS::DebuggingControl, HPS::SubwindowControl, HPS::ContourLineControl, HPS::VisualEffectsControl, HPS::TransformMaskControl, HPS::PostProcessEffectsControl, HPS::DrawingAttributeControl, HPS::HiddenLineAttributeControl, HPS::PerformanceControl, HPS::NURBSSurfaceAttributeControl, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::CurveAttributeControl, HPS::EdgeAttributeControl, HPS::LineAttributeControl, HPS::TextAttributeControl, HPS::CuttingSectionAttributeControl, HPS::CylinderAttributeControl, HPS::LightingAttributeControl, HPS::SphereAttributeControl, HPS::MarkerAttributeControl, HPS::CullingControl, HPS::ColorInterpolationControl, HPS::TransparencyControl, HPS::SelectabilityControl, HPS::CameraControl, HPS::VisibilityControl, HPS::BoundingControl, HPS::Kit, and HPS::Control.

UnsetEverything() [1/2]

OperatorControl& HPS::OperatorControl::UnsetEverything

(

Operator::Priority

in_priority

)

Removes all operators from the operator stack of the specified priority and frees the memory associated with them.

Parameters

in_priority

The priority of the operator to be removed.

Returns

A reference to this object.

UnsetEverything() [2/2]

OperatorControl& HPS::OperatorControl::UnsetEverything

(

)

Removes all operators from the operator stack of any priority and frees the memory associated with them.

Returns

A reference to this object.

UnsetTop()

OperatorControl& HPS::OperatorControl::UnsetTop

(

Operator::Priority

in_priority = Operator::Priority::Default

)

Removes the top operator from the operator stack of the specified priority and frees the memory associated with it.

Parameters

in_priority

The priority of the operator to be removed.

Returns

A reference to this object.

Member Data Documentation

staticType

const HPS::Type HPS::OperatorControl::staticType = HPS::Type::OperatorControl

static

---

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

• sprk.h