HPS::HighlightControl Class Reference

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

#include <hps.h>

Inheritance diagram for HPS::HighlightControl:

Collaboration diagram for HPS::HighlightControl:

Public Member Functions
	HighlightControl (WindowKey const &in_window)
	This constructor creates a HighlightControl object which is tied to the specified window. More...
	HighlightControl (HighlightControl const &in_that)
	The copy constructor creates a HighlightControl object that shares the underlying smart-pointer of the source HighlightControl. More...
	HighlightControl (HighlightControl &&in_that)
	The move constructor creates a HighlightControl by transferring the underlying impl of the rvalue reference to this HighlightControl thereby avoiding a copy and allocation. More...
HighlightControl &	operator= (HighlightControl &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this HighlightControl thereby avoiding a copy. More...
	~HighlightControl ()
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
HPS::Type	ObjectType () const
HighlightControl &	operator= (HighlightControl const &in_that)
	Share the underlying smart-pointer of the HighlightControl source. More...
HighlightControl &	Highlight (SelectionResults const &in_items, HighlightOptionsKit const &in_options, bool in_remove_existing=true)
	Highlight the specified selection results using the specified highlight options. More...
HighlightControl &	Highlight (SelectionItem const &in_item, HighlightOptionsKit const &in_options, bool in_remove_existing=true)
	Highlight the specified selection item using the specified highlight options. More...
HighlightControl &	Highlight (SearchResults const &in_items, HighlightOptionsKit const &in_options, bool in_remove_existing=true)
	Highlight the specified search results using the specified highlight options. More...
HighlightControl &	Highlight (KeyPath const &in_item, HighlightOptionsKit const &in_options, bool in_remove_existing=true)
	Highlight the specified key path using the specified highlight options. More...
HighlightControl &	Highlight (Key const &in_item, HighlightOptionsKit const &in_options, bool in_remove_existing=true)
	Highlight the specified key using the specified highlight options. More...
HighlightControl &	Highlight (KeyPath const &in_item, HighlightOptionsKit const &in_options, SizeTArray const &in_vertices, SizeTArray const &in_edges1, SizeTArray const &in_edges2, SizeTArray const &in_faces, bool in_remove_existing=true)
	Highlight specified subentities for the specified key path using the specified highlight options. More...
HighlightControl &	Highlight (Key const &in_item, HighlightOptionsKit const &in_options, SizeTArray const &in_vertices, SizeTArray const &in_edges1, SizeTArray const &in_edges2, SizeTArray const &in_faces, bool in_remove_existing=true)
	Highlight the specified key using the specified highlight options. More...
HighlightControl &	Highlight (KeyPath const &in_item, HighlightOptionsKit const &in_options, size_t in_vertices_count, size_t const in_vertices[], size_t in_edges_count, size_t const in_edges1[], size_t const in_edges2[], size_t in_faces_count, size_t const in_faces[], bool in_remove_existing=true)
	Highlight subentities from the specified item using the specified highlight options. More...
HighlightControl &	Highlight (Key const &in_item, HighlightOptionsKit const &in_options, size_t in_vertices_count, size_t const in_vertices[], size_t in_edges_count, size_t const in_edges1[], size_t const in_edges2[], size_t in_faces_count, size_t const in_faces[], bool in_remove_existing=true)
	Highlight subentities from the specified item using the specified highlight options. More...
HighlightControl &	Unhighlight (SelectionResults const &in_items, HighlightOptionsKit const &in_options=HighlightOptionsKit())
	Unhighlight the specified selection results by removing the specified highlight options. More...
HighlightControl &	Unhighlight (SelectionItem const &in_item, HighlightOptionsKit const &in_options=HighlightOptionsKit())
	Unhighlight the specified selection item by removing the specified highlight options. More...
HighlightControl &	Unhighlight (SearchResults const &in_items, HighlightOptionsKit const &in_options=HighlightOptionsKit())
	Unhighlight the specified search results by removing the specified highlight options. More...
HighlightControl &	Unhighlight (KeyPath const &in_item, HighlightOptionsKit const &in_options=HighlightOptionsKit())
	Unhighlight the specified key path by removing the specified highlight options. More...
HighlightControl &	Unhighlight (Key const &in_item, HighlightOptionsKit const &in_options=HighlightOptionsKit())
	Unhighlight the specified key by removing the specified highlight options. More...
HighlightControl &	Unhighlight (KeyPath const &in_item, HighlightOptionsKit const &in_options, SizeTArray const &in_vertices, SizeTArray const &in_edges1, SizeTArray const &in_edges2, SizeTArray const &in_faces)
	Unhighlight subentities from the specified key path by removing the specified highlight options. More...
HighlightControl &	Unhighlight (Key const &in_item, HighlightOptionsKit const &in_options, SizeTArray const &in_vertices, SizeTArray const &in_edges1, SizeTArray const &in_edges2, SizeTArray const &in_faces)
	Unhighlight subentities from the specified item by removing the specified highlight options. More...
HighlightControl &	Unhighlight (KeyPath const &in_item, HighlightOptionsKit const &in_options, size_t in_vertices_count, size_t const in_vertices[], size_t in_edges_count, size_t const in_edges1[], size_t const in_edges2[], size_t in_faces_count, size_t const in_faces[])
	Unhighlight subentities from the specified item by removing the specified highlight options. More...
HighlightControl &	Unhighlight (Key const &in_item, HighlightOptionsKit const &in_options, size_t in_vertices_count, size_t const in_vertices[], size_t in_edges_count, size_t const in_edges1[], size_t const in_edges2[], size_t in_faces_count, size_t const in_faces[])
	Unhighlight subentities from the specified item by removing the specified highlight options. More...
HighlightControl &	Unhighlight (HighlightOptionsKit const &in_options)
	Unhighlight geometry which was highlighted with the specified HighlightOptionsKit. More...
HighlightControl &	UnhighlightEverything ()
	Unhighlight everything in the window associated with this HighlightControl. More...
void	ShowHighlightState (Key const &in_key, HighlightSearchOptionsKit const &in_search_options, HighlightState &out_state) const
	Show the highlight information for the given key and search options. More...
void	ShowHighlightState (KeyPath const &in_key_path, HighlightSearchOptionsKit const &in_search_options, HighlightState &out_state) const
	Show the highlight information for the given key path and search options. More...
void	ShowHighlightStates (KeyArray const &in_keys, HighlightSearchOptionsKit const &in_search_options, HighlightStateArray &out_states) const
	Show the highlight information for the given keys and search options. More...
void	ShowHighlightStates (KeyPathArray const &in_key_paths, HighlightSearchOptionsKit const &in_search_options, HighlightStateArray &out_states) const
	Show the highlight information for the given key paths and search options. 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::HighlightControl

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

Detailed Description

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

It is used to control highlight and unhighlight operations on selection results, search results, key paths and keys. This table lists default * values for the various segment attributes accessible from HPS::HighlightControl.

Constructor & Destructor Documentation

HighlightControl() [1/4]

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

explicit

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

Parameters

in_window

The window which this HighlightControl should operate on.

HighlightControl() [2/4]

HPS::HighlightControl::HighlightControl

(

HighlightControl const &

in_that

)

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

Parameters

in_that

The source HighlightControl to copy.

HighlightControl() [3/4]

HPS::HighlightControl::HighlightControl

(

HighlightControl &&

in_that

)

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

Parameters

in_that

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

~HighlightControl()

HPS::HighlightControl::~HighlightControl

(

)

HighlightControl() [4/4]

HPS::HighlightControl::HighlightControl ( )

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.

Highlight() [1/9]

HighlightControl& HPS::HighlightControl::Highlight	(	SelectionResults const &	in_items,
		HighlightOptionsKit const &	in_options,
		bool	in_remove_existing = true
	)

Highlight the specified selection results using the specified highlight options.

Parameters

in_items	The selection results to highlight. If there are invalid selection items in the selection results, an exception will be thrown.
in_options	The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
in_remove_existing	Indicates whether this highlight should flush existing highlights at the specified path for the desired overlay type.

Returns

A reference to this HighlightControl.

Highlight() [2/9]

HighlightControl& HPS::HighlightControl::Highlight	(	SelectionItem const &	in_item,
		HighlightOptionsKit const &	in_options,
		bool	in_remove_existing = true
	)

Highlight the specified selection item using the specified highlight options.

Parameters

in_item	The selection item to highlight. If the selection item is invalid, an exception will be thrown.
in_options	The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
in_remove_existing	Indicates whether this highlight should flush existing highlights at the specified path for the desired overlay type.

Returns

A reference to this HighlightControl.

Highlight() [3/9]

HighlightControl& HPS::HighlightControl::Highlight	(	SearchResults const &	in_items,
		HighlightOptionsKit const &	in_options,
		bool	in_remove_existing = true
	)

Highlight the specified search results using the specified highlight options.

Parameters

in_items	The search results to highlight. If there are invalid keys in the selection results, an exception will be thrown.
in_options	The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
in_remove_existing	Indicates whether this highlight should flush existing highlights at the specified path for the desired overlay type.

Returns

A reference to this HighlightControl.

Highlight() [4/9]

HighlightControl& HPS::HighlightControl::Highlight	(	KeyPath const &	in_item,
		HighlightOptionsKit const &	in_options,
		bool	in_remove_existing = true
	)

Highlight the specified key path using the specified highlight options.

Parameters

in_item	The key path to highlight. If there are no keys or invalid keys in the key path, an exception will be thrown.
in_options	The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
in_remove_existing	Indicates whether this highlight should flush existing highlights at the specified path for the desired overlay type.

Returns

A reference to this HighlightControl.

Highlight() [5/9]

HighlightControl& HPS::HighlightControl::Highlight	(	Key const &	in_item,
		HighlightOptionsKit const &	in_options,
		bool	in_remove_existing = true
	)

Highlight the specified key using the specified highlight options.

Parameters

in_item	The key to highlight. If the key is invalid, an exception will be thrown.
in_options	The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
in_remove_existing	Indicates whether this highlight should flush existing highlights at the specified path for the desired overlay type.

Returns

A reference to this HighlightControl.

Highlight() [6/9]

HighlightControl& HPS::HighlightControl::Highlight	(	KeyPath const &	in_item,
		HighlightOptionsKit const &	in_options,
		SizeTArray const &	in_vertices,
		SizeTArray const &	in_edges1,
		SizeTArray const &	in_edges2,
		SizeTArray const &	in_faces,
		bool	in_remove_existing = true
	)

Highlight specified subentities for the specified key path using the specified highlight options.

Parameters

in_item	The key path to highlight. If there are no keys or invalid keys in the key path, an exception will be thrown.
in_options	The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
in_vertices	An array of vertex indices, specfying vertices to highlight.
in_edges1	An array of vertex indices, which when paired with the corresponding entries in the in_edges2 array, define a list of edges to highlight.
in_edges2	An array of vertex indices to be paired with entries in in_edges1 array to define the edge list.
in_faces	An array of faces indices specifying faces to highlight.
in_remove_existing	Indicates whether this highlight should flush existing highlights at the specified path for the desired overlay type.

Returns

A reference to this HighlightControl.

Highlight() [7/9]

HighlightControl& HPS::HighlightControl::Highlight	(	Key const &	in_item,
		HighlightOptionsKit const &	in_options,
		SizeTArray const &	in_vertices,
		SizeTArray const &	in_edges1,
		SizeTArray const &	in_edges2,
		SizeTArray const &	in_faces,
		bool	in_remove_existing = true
	)

Highlight the specified key using the specified highlight options.

Parameters

in_item	The key to highlight. If the key is invalid, an exception will be thrown.
in_options	The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
in_vertices	An array of vertex indices, specifying vertices to highlight.
in_edges1	An array of vertex indices, which when paired with the corresponding entries in the in_edges2 array, define a list of edges to highlight.
in_edges2	An array of vertex indices to be paired with entries in in_edges1 array to define the edge list.
in_faces	An array of faces indices specifying faces to highlight.
in_remove_existing	Indicates whether this highlight should flush existing highlights at the specified path for the desired overlay type.

Returns

A reference to this HighlightControl.

Highlight() [8/9]

HighlightControl& HPS::HighlightControl::Highlight	(	KeyPath const &	in_item,
		HighlightOptionsKit const &	in_options,
		size_t	in_vertices_count,
		size_t const	in_vertices[],
		size_t	in_edges_count,
		size_t const	in_edges1[],
		size_t const	in_edges2[],
		size_t	in_faces_count,
		size_t const	in_faces[],
		bool	in_remove_existing = true
	)

Highlight subentities from the specified item using the specified highlight options.

Parameters

in_item	The key path to highlight. If there are no keys or invalid keys in the key path, an exception will be thrown.
in_options	The options to use when performing the highlight.
in_vertices_count	The number of elements to read from the in_vertices array.
in_vertices	An array of vertex indices, specifying vertices to highlight.
in_edges_count	The number of elements to read from the in_edges1/in_edges2 arrays.
in_edges1	An array of vertex indices, which when paired with the corresponding entries in the in_edges2 array, define a list of edges to highlight.
in_edges2	An array of vertex indices to be paired with entries in in_edges1 array to define the edge list.
in_faces_count	The number of elements to read from the in_faces array.
in_faces	An array of faces indices specifying faces to highlight.
in_remove_existing	Indicates whether this highlight should flush existing highlights at the specified path for the desired overlay type.

Returns

A reference to this HighlightControl.

Highlight() [9/9]

HighlightControl& HPS::HighlightControl::Highlight	(	Key const &	in_item,
		HighlightOptionsKit const &	in_options,
		size_t	in_vertices_count,
		size_t const	in_vertices[],
		size_t	in_edges_count,
		size_t const	in_edges1[],
		size_t const	in_edges2[],
		size_t	in_faces_count,
		size_t const	in_faces[],
		bool	in_remove_existing = true
	)

Highlight subentities from the specified item using the specified highlight options.

Parameters

in_item	The key to highlight. If there are no keys or invalid keys in the key path, an exception will be thrown.
in_options	The options to use when performing the highlight.
in_vertices_count	The number of elements to read from the in_vertices array.
in_vertices	An array of vertex indices, specifying vertices to highlight.
in_edges_count	The number of elements to read from the in_edges1/in_edges2 arrays.
in_edges1	An array of vertex indices, which when paired with the corresponding entries in the in_edges2 array, define a list of edges to highlight.
in_edges2	An array of vertex indices to be paired with entries in in_edges1 array to define the edge list.
in_faces_count	The number of elements to read from the in_faces array.
in_faces	An array of faces indices specifying faces to highlight.
in_remove_existing	Indicates whether this highlight should flush existing highlights at the specified path for the desired overlay type.

Returns

A reference to this HighlightControl.

ObjectType()

HPS::Type HPS::HighlightControl::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Control.

operator=() [1/2]

HighlightControl& HPS::HighlightControl::operator=

(

HighlightControl &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this HighlightControl.

operator=() [2/2]

HighlightControl& HPS::HighlightControl::operator=

(

HighlightControl const &

in_that

)

Share the underlying smart-pointer of the HighlightControl source.

Parameters

in_that

The HighlightControl source of the assignment.

Returns

A reference to this HighlightControl.

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.

ShowHighlightState() [1/2]

void HPS::HighlightControl::ShowHighlightState	(	Key const &	in_key,
		HighlightSearchOptionsKit const &	in_search_options,
		HighlightState &	out_state
	)		const

Show the highlight information for the given key and search options.

Parameters

in_key	Key to get highlight information for.
in_search_options	Search options constraining what type of highlights to look for. If this is empty, all highlights will be considered.
out_state	Highlight information for the queried key.

ShowHighlightState() [2/2]

void HPS::HighlightControl::ShowHighlightState	(	KeyPath const &	in_key_path,
		HighlightSearchOptionsKit const &	in_search_options,
		HighlightState &	out_state
	)		const

Show the highlight information for the given key path and search options.

Parameters

in_key_path	Key path to get highlight information for.
in_search_options	Search options constraining what type of highlights to look for. If this is empty, all highlights will be considered.
out_state	Highlight information for the queried key path.

ShowHighlightStates() [1/2]

void HPS::HighlightControl::ShowHighlightStates	(	KeyArray const &	in_keys,
		HighlightSearchOptionsKit const &	in_search_options,
		HighlightStateArray &	out_states
	)		const

Show the highlight information for the given keys and search options.

Parameters

in_keys	Keys to get highlight information for.
in_search_options	Search options constraining what type of highlights to look for. If this is empty, all highlights will be considered.
out_states	Highlight information for the queried keys.

ShowHighlightStates() [2/2]

void HPS::HighlightControl::ShowHighlightStates	(	KeyPathArray const &	in_key_paths,
		HighlightSearchOptionsKit const &	in_search_options,
		HighlightStateArray &	out_states
	)		const

Show the highlight information for the given key paths and search options.

Parameters

in_key_paths	Key paths to get highlight information for.
in_search_options	Search options constraining what type of highlights to look for. If this is empty, all highlights will be considered.
out_states	Highlight information for the queried key paths.

Type()

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

Unhighlight() [1/10]

HighlightControl& HPS::HighlightControl::Unhighlight	(	SelectionResults const &	in_items,
		HighlightOptionsKit const &	in_options = HighlightOptionsKit()
	)

Unhighlight the specified selection results by removing the specified highlight options.

Parameters

in_items	The selection results to unhighlight. If there are invalid selection items in the selection results, an exception will be thrown.
in_options	The highlight options to be removed. Defaults to an empty HighlightOptionsKit.

Returns

A reference to this HighlightControl.

Unhighlight() [2/10]

HighlightControl& HPS::HighlightControl::Unhighlight	(	SelectionItem const &	in_item,
		HighlightOptionsKit const &	in_options = HighlightOptionsKit()
	)

Unhighlight the specified selection item by removing the specified highlight options.

Parameters

in_item	The selection item to unhighlight. If the selection item is invalid, an exception will be thrown.
in_options	The highlight options to be removed. Defaults to an empty HighlightOptionsKit.

Returns

A reference to this HighlightControl.

Unhighlight() [3/10]

HighlightControl& HPS::HighlightControl::Unhighlight	(	SearchResults const &	in_items,
		HighlightOptionsKit const &	in_options = HighlightOptionsKit()
	)

Unhighlight the specified search results by removing the specified highlight options.

Parameters

in_items	The search results to unhighlight. If there are invalid keys in the search results, an exception will be thrown.
in_options	The highlight options to be removed. Defaults to an empty HighlightOptionsKit.

Returns

A reference to this HighlightControl.

Unhighlight() [4/10]

HighlightControl& HPS::HighlightControl::Unhighlight	(	KeyPath const &	in_item,
		HighlightOptionsKit const &	in_options = HighlightOptionsKit()
	)

Unhighlight the specified key path by removing the specified highlight options.

Parameters

in_item	The key path to unhighlight. If there are no keys or invalid keys in the key path, an exception will be thrown.
in_options	The highlight options to be removed. Defaults to an empty HighlightOptionsKit.

Returns

A reference to this HighlightControl.

Unhighlight() [5/10]

HighlightControl& HPS::HighlightControl::Unhighlight	(	Key const &	in_item,
		HighlightOptionsKit const &	in_options = HighlightOptionsKit()
	)

Unhighlight the specified key by removing the specified highlight options.

Parameters

in_item	The key to unhighlight. If the key is invalid, an exception will be thrown..
in_options	The highlight options to be removed. Defaults to an empty HighlightOptionsKit.

Returns

A reference to this HighlightControl.

Unhighlight() [6/10]

HighlightControl& HPS::HighlightControl::Unhighlight	(	KeyPath const &	in_item,
		HighlightOptionsKit const &	in_options,
		SizeTArray const &	in_vertices,
		SizeTArray const &	in_edges1,
		SizeTArray const &	in_edges2,
		SizeTArray const &	in_faces
	)

Unhighlight subentities from the specified key path by removing the specified highlight options.

Parameters

in_item	The key path to unhighlight. If there are no keys or invalid keys in the key path, an exception will be thrown.
in_options	The highlight options to be removed. Defaults to an empty HighlightOptionsKit.
in_vertices	An array of vertex indices, specifying vertices to unhighlight.
in_edges1	An array of vertex indices, which when paired with the corresponding entries in the in_edges2 array, define a list of edges to unhighlight.
in_edges2	An array of vertex indices to be paired with entries in in_edges1 array to define the edge list.
in_faces	An array of faces indices specifying faces to unhighlight.

Returns

A reference to this HighlightControl.

Unhighlight() [7/10]

HighlightControl& HPS::HighlightControl::Unhighlight	(	Key const &	in_item,
		HighlightOptionsKit const &	in_options,
		SizeTArray const &	in_vertices,
		SizeTArray const &	in_edges1,
		SizeTArray const &	in_edges2,
		SizeTArray const &	in_faces
	)

Unhighlight subentities from the specified item by removing the specified highlight options.

Parameters

in_item	The key to unhighlight. If the key is invalid, an exception will be thrown..
in_options	The highlight options to be removed. Defaults to an empty HighlightOptionsKit.
in_vertices	An array of vertex indices, specifying vertices to unhighlight.
in_edges1	An array of vertex indices, which when paired with the corresponding entries in the in_edges2 array, define a list of edges to unhighlight.
in_edges2	An array of vertex indices to be paired with entries in in_edges1 array to define the edge list.
in_faces	An array of faces indices specifying faces to unhighlight.

Returns

A reference to this HighlightControl.

Unhighlight() [8/10]

HighlightControl& HPS::HighlightControl::Unhighlight	(	KeyPath const &	in_item,
		HighlightOptionsKit const &	in_options,
		size_t	in_vertices_count,
		size_t const	in_vertices[],
		size_t	in_edges_count,
		size_t const	in_edges1[],
		size_t const	in_edges2[],
		size_t	in_faces_count,
		size_t const	in_faces[]
	)

Unhighlight subentities from the specified item by removing the specified highlight options.

Parameters

in_item	The key path to unhighlight. If there are no keys or invalid keys in the key path, an exception will be thrown.
in_options	The highlight options to be removed. Defaults to an empty HighlightOptionsKit.
in_vertices_count	The number of elements to read from the in_vertices array.
in_vertices	An array of vertex indices, specifying vertices to unhighlight.
in_edges_count	The number of elements to read from the in_edges1/in_edges2 arrays.
in_edges1	An array of vertex indices, which when paired with the corresponding entries in the in_edges2 array, define a list of edges to unhighlight.
in_edges2	An array of vertex indices to be paired with entries in in_edges1 array to define the edge list.
in_faces_count	The number of elements to read from the in_faces array.
in_faces	An array of faces indices specifying faces to unhighlight.

Returns

A reference to this HighlightControl.

Unhighlight() [9/10]

HighlightControl& HPS::HighlightControl::Unhighlight	(	Key const &	in_item,
		HighlightOptionsKit const &	in_options,
		size_t	in_vertices_count,
		size_t const	in_vertices[],
		size_t	in_edges_count,
		size_t const	in_edges1[],
		size_t const	in_edges2[],
		size_t	in_faces_count,
		size_t const	in_faces[]
	)

Unhighlight subentities from the specified item by removing the specified highlight options.

Parameters

in_item	The key to unhighlight. If the key is invalid, an exception will be thrown..
in_options	The highlight options to be removed. Defaults to an empty HighlightOptionsKit.
in_vertices_count	The number of elements to read from the in_vertices array.
in_vertices	An array of vertex indices, specifying vertices to unhighlight.
in_edges_count	The number of elements to read from the in_edges1/in_edges2 arrays.
in_edges1	An array of vertex indices, which when paired with the corresponding entries in the in_edges2 array, define a list of edges to unhighlight.
in_edges2	An array of vertex indices to be paired with entries in in_edges1 array to define the edge list.
in_faces_count	The number of elements to read from the in_faces array.
in_faces	An array of faces indices specifying faces to unhighlight.

Returns

A reference to this HighlightControl.

Unhighlight() [10/10]

HighlightControl& HPS::HighlightControl::Unhighlight

(

HighlightOptionsKit const &

in_options

)

Unhighlight geometry which was highlighted with the specified HighlightOptionsKit.

Parameters

in_options

The highlight options to be removed.

Returns

A reference to this HighlightControl.

UnhighlightEverything()

HighlightControl& HPS::HighlightControl::UnhighlightEverything

(

)

Unhighlight everything in the window associated with this HighlightControl.

Returns

A reference to this HighlightControl.

Member Data Documentation

staticType

const HPS::Type HPS::HighlightControl::staticType = HPS::Type::HighlightControl

static

---

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

• hps.h