HPS::AttributeLockControl Class Reference

The HPS::AttributeLockControl class provides support for attribute locking, which allows temporarily override of an attribute setting for a segment and its descendants. More...

#include <hps.h>

Inheritance diagram for HPS::AttributeLockControl:

Collaboration diagram for HPS::AttributeLockControl:

Public Member Functions
	AttributeLockControl (SegmentKey &in_seg)
	Initializes a control tied to the segment in_seg. More...
	AttributeLockControl (AttributeLockControl &&in_that)
	The move constructor creates a AttributeLockKit by transferring the underlying impl of the rvalue reference to this AttributeLockKit thereby avoiding a copy and allocation. More...
AttributeLockControl &	operator= (AttributeLockControl &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this AttributeLockControl thereby avoiding a copy. More...
	AttributeLockControl (AttributeLockControl const &in_that)
	Initializes a control tied to the same object as in_that. More...
	~AttributeLockControl ()
	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
AttributeLockControl &	operator= (AttributeLockControl const &in_that)
	Share the underlying smart-pointer of the AttributeLockControl source. More...
AttributeLockControl &	SetLock (AttributeLock::Type in_type, bool in_state=true)
	Applies an attribute lock that prevents attributes of the chosen type from being modified in child segments. More...
AttributeLockControl &	SetLock (AttributeLockTypeArray const &in_types, BoolArray const &in_states)
	Applies attribute locks that prevents attributes of the chosen types from being modified in child segments. More...
AttributeLockControl &	SetSubsegmentLockOverride (AttributeLock::Type in_type, bool in_state=true)
	Normally, if a segment applies an attribute lock it will defeat an existing lock set in a parent segment. More...
AttributeLockControl &	SetSubsegmentLockOverride (AttributeLockTypeArray const &in_types, BoolArray const &in_states)
	Normally, if a segment applies an attribute lock it will defeat an existing lock set in a parent segment. More...
AttributeLockControl &	UnsetLock (AttributeLock::Type in_type=AttributeLock::Type::Everything)
	Removes an attribute lock setting. More...
AttributeLockControl &	UnsetLock (AttributeLockTypeArray const &in_types)
	Removes a collection of attribute lock settings. More...
AttributeLockControl &	UnsetSubsegmentLockOverride (AttributeLock::Type in_type=AttributeLock::Type::Everything)
	Removes a subsegment lock override setting. More...
AttributeLockControl &	UnsetSubsegmentLockOverride (AttributeLockTypeArray const &in_types)
	Removes a collection of subsegment lock override settings. More...
AttributeLockControl &	UnsetEverything ()
	Removes all settings from this object. More...
bool	ShowLock (AttributeLock::Type in_type, bool &out_state) const
	Shows the state of a particular attribute lock. More...
bool	ShowLock (AttributeLockTypeArray &out_types, BoolArray &out_states) const
	Shows the state of all attribute locks. More...
bool	ShowSubsegmentLockOverride (AttributeLock::Type in_type, bool &out_state) const
	Shows the state of a particular subsegment lock override. More...
bool	ShowSubsegmentLockOverride (AttributeLockTypeArray &out_types, BoolArray &out_states) const
	Shows the state of all subsegment lock overrides. 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::AttributeLockControl

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

Detailed Description

The HPS::AttributeLockControl class provides support for attribute locking, which allows temporarily override of an attribute setting for a segment and its descendants.

This control is used to set and unset attribute locks at the segment level. For more information, see Core Graphics Programming Guide, section 1.2.4 - subsection "Attribute controls". This table lists default values for the various segment attributes accessible from HPS::AttributeLockControl.

Constructor & Destructor Documentation

AttributeLockControl() [1/4]

HPS::AttributeLockControl::AttributeLockControl ( SegmentKey &  in_seg )

explicit

Initializes a control tied to the segment in_seg.

AttributeLockControl() [2/4]

HPS::AttributeLockControl::AttributeLockControl

(

AttributeLockControl &&

in_that

)

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

Parameters

in_that

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

AttributeLockControl() [3/4]

HPS::AttributeLockControl::AttributeLockControl

(

AttributeLockControl const &

in_that

)

Initializes a control tied to the same object as in_that.

~AttributeLockControl()

HPS::AttributeLockControl::~AttributeLockControl

(

)

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

AttributeLockControl() [4/4]

HPS::AttributeLockControl::AttributeLockControl ( )

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

inlinevirtual

Reimplemented from HPS::Control.

operator=() [1/2]

AttributeLockControl& HPS::AttributeLockControl::operator=

(

AttributeLockControl &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this AttributeLockControl.

operator=() [2/2]

AttributeLockControl& HPS::AttributeLockControl::operator=

(

AttributeLockControl const &

in_that

)

Share the underlying smart-pointer of the AttributeLockControl source.

Parameters

in_that

The AttributeLockControl source of the assignment.

Returns

A reference to this AttributeLockControl.

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.

SetLock() [1/2]

AttributeLockControl& HPS::AttributeLockControl::SetLock	(	AttributeLock::Type	in_type,
		bool	in_state = true
	)

Applies an attribute lock that prevents attributes of the chosen type from being modified in child segments.

Parameters

in_type	The type of attribute to lock or unlock.
in_state	Whether the attribute should be locked.

Returns

A reference to this object.

See also

Attribute lock default value

SetLock() [2/2]

AttributeLockControl& HPS::AttributeLockControl::SetLock	(	AttributeLockTypeArray const &	in_types,
		BoolArray const &	in_states
	)

Applies attribute locks that prevents attributes of the chosen types from being modified in child segments.

Parameters

in_types	An array of attribute types that should be locked or unlocked.
in_states	An array of bools with each one indicating whether the corresponding type in in_types should be locked.

Returns

A reference to this object.

SetSubsegmentLockOverride() [1/2]

AttributeLockControl& HPS::AttributeLockControl::SetSubsegmentLockOverride	(	AttributeLock::Type	in_type,
		bool	in_state = true
	)

Normally, if a segment applies an attribute lock it will defeat an existing lock set in a parent segment.

This method designates a particular lock as a "super lock" that cannot be overridden by subsegments.

Parameters

in_type	The type of attribute lock that should be ignored in subsegments.
in_state	Whether the attribute lock should override locks in subsegments.

Returns

A reference to this object.

SetSubsegmentLockOverride() [2/2]

AttributeLockControl& HPS::AttributeLockControl::SetSubsegmentLockOverride	(	AttributeLockTypeArray const &	in_types,
		BoolArray const &	in_states
	)

Normally, if a segment applies an attribute lock it will defeat an existing lock set in a parent segment.

This method designates a collection of locks as a "super locks" that cannot be overridden by subsegments.

Parameters

in_type	Ann array of types of attribute locks that should be ignored in subsegments.
in_state	An array of bools with each one indicating whether the corresponding attribute lock in in_types should override locks in subsegments.

Returns

A reference to this object.

ShowLock() [1/2]

bool HPS::AttributeLockControl::ShowLock	(	AttributeLock::Type	in_type,
		bool &	out_state
	)		const

Shows the state of a particular attribute lock.

Parameters

in_type	The type of attribute lock to be queried.
out_state	Whether the attribute is locked.

Returns

true if the setting is valid, false otherwise.

ShowLock() [2/2]

bool HPS::AttributeLockControl::ShowLock	(	AttributeLockTypeArray &	out_types,
		BoolArray &	out_states
	)		const

Shows the state of all attribute locks.

Parameters

out_types	An array of types that have an attribute lock setting.
out_states	An array of bools with each indicating whether the corresponding entry in in_types is locked.

Returns

true if the setting is valid, false otherwise.

ShowSubsegmentLockOverride() [1/2]

bool HPS::AttributeLockControl::ShowSubsegmentLockOverride	(	AttributeLock::Type	in_type,
		bool &	out_state
	)		const

Shows the state of a particular subsegment lock override.

Parameters

in_type	The type of attribute lock to be queried.
out_state	Whether the attribute lock will override locks in subsegments.

Returns

true if the setting is valid, false otherwise.

ShowSubsegmentLockOverride() [2/2]

bool HPS::AttributeLockControl::ShowSubsegmentLockOverride	(	AttributeLockTypeArray &	out_types,
		BoolArray &	out_states
	)		const

Shows the state of all subsegment lock overrides.

Parameters

out_types	An array of types that have a subsegment lock override setting.
out_states	An array of bools with each indicating whether the corresponding entry in in_types is will be ignored in subsegments.

Returns

true if the setting is valid, false otherwise.

Type()

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

AttributeLockControl& HPS::AttributeLockControl::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 AttributeLockKit::GetDefault().

Returns

A reference to this object.

UnsetLock() [1/2]

AttributeLockControl& HPS::AttributeLockControl::UnsetLock

(

AttributeLock::Type

in_type = AttributeLock::Type::Everything

)

Removes an attribute lock setting.

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

Returns

A reference to this object.

UnsetLock() [2/2]

AttributeLockControl& HPS::AttributeLockControl::UnsetLock

(

AttributeLockTypeArray const &

in_types

)

Removes a collection of attribute lock settings.

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

Returns

A reference to this object.

UnsetSubsegmentLockOverride() [1/2]

AttributeLockControl& HPS::AttributeLockControl::UnsetSubsegmentLockOverride

(

AttributeLock::Type

in_type = AttributeLock::Type::Everything

)

Removes a subsegment lock override setting.

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

Returns

A reference to this object.

UnsetSubsegmentLockOverride() [2/2]

AttributeLockControl& HPS::AttributeLockControl::UnsetSubsegmentLockOverride

(

AttributeLockTypeArray const &

in_types

)

Removes a collection of subsegment lock override settings.

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

Returns

A reference to this object.

Member Data Documentation

staticType

const HPS::Type HPS::AttributeLockControl::staticType = HPS::Type::AttributeLockControl

static

---

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

• hps.h