HighlightControl

class HPS.HighlightControl : HPS.Control 

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.

Public Functions

override void Dispose ()

HPS.HighlightControl Highlight (HPS.Key in_item, HPS.HighlightOptionsKit in_options)

Highlight the specified key using the specified highlight options.

Param in_options:
Param in_item:	The key to highlight. If the key is invalid, an exception will be thrown.
	The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
Return:	A reference to this HighlightControl.

HPS.HighlightControl Highlight (HPS.Key in_item, HPS.HighlightOptionsKit in_options, bool in_remove_existing)

Highlight the specified key using the specified highlight options.

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

HPS.HighlightControl Highlight (HPS.Key in_item, HPS.HighlightOptionsKit in_options, ulong[] in_vertices, ulong[] in_edges1, ulong[] in_edges2, ulong[] in_faces)

Highlight the specified key using the specified highlight options.

Param in_options:
Param in_item:	The key to highlight. If the key is invalid, an exception will be thrown.
	The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
Param in_vertices:
	An array of vertex indices, specifying vertices to highlight.
Param 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.
Param in_edges2:
	An array of vertex indices to be paired with entries in in_edges1 array to define the edge list.
Param in_faces:	An array of faces indices specifying faces to highlight.
Return:	A reference to this HighlightControl.

HPS.HighlightControl Highlight (HPS.Key in_item, HPS.HighlightOptionsKit in_options, ulong[] in_vertices, ulong[] in_edges1, ulong[] in_edges2, ulong[] in_faces, bool in_remove_existing)

Highlight the specified key using the specified highlight options.

Param in_options:
Param in_item:	The key to highlight. If the key is invalid, an exception will be thrown.
	The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
Param in_vertices:
	An array of vertex indices, specifying vertices to highlight.
Param 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.
Param in_edges2:
	An array of vertex indices to be paired with entries in in_edges1 array to define the edge list.
Param in_faces:	An array of faces indices specifying faces to highlight.
Param in_remove_existing:
	Indicates whether this highlight should flush existing highlights at the specified path for the desired overlay type.
Return:	A reference to this HighlightControl.

HPS.HighlightControl Highlight (HPS.KeyPath in_item, HPS.HighlightOptionsKit in_options)

Highlight the specified key path using the specified highlight options.

Param in_options:
Param in_item:	The key path to highlight. If there are no keys or invalid keys in the key path, an exception will be thrown.
	The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
Return:	A reference to this HighlightControl.

HPS.HighlightControl Highlight (HPS.KeyPath in_item, HPS.HighlightOptionsKit in_options, bool in_remove_existing)

Highlight the specified key path using the specified highlight options.

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

HPS.HighlightControl Highlight (HPS.KeyPath in_item, HPS.HighlightOptionsKit in_options, ulong[] in_vertices, ulong[] in_edges1, ulong[] in_edges2, ulong[] in_faces)

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

Param in_options:
Param in_item:	The key path to highlight. If there are no keys or invalid keys in the key path, an exception will be thrown.
	The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
Param in_vertices:
	An array of vertex indices, specifying vertices to highlight.
Param 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.
Param in_edges2:
	An array of vertex indices to be paired with entries in in_edges1 array to define the edge list.
Param in_faces:	An array of faces indices specifying faces to highlight.
Return:	A reference to this HighlightControl.

HPS.HighlightControl Highlight (HPS.KeyPath in_item, HPS.HighlightOptionsKit in_options, ulong[] in_vertices, ulong[] in_edges1, ulong[] in_edges2, ulong[] in_faces, bool in_remove_existing)

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

Param in_options:
Param in_item:	The key path to highlight. If there are no keys or invalid keys in the key path, an exception will be thrown.
	The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
Param in_vertices:
	An array of vertex indices, specifying vertices to highlight.
Param 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.
Param in_edges2:
	An array of vertex indices to be paired with entries in in_edges1 array to define the edge list.
Param in_faces:	An array of faces indices specifying faces to highlight.
Param in_remove_existing:
	Indicates whether this highlight should flush existing highlights at the specified path for the desired overlay type.
Return:	A reference to this HighlightControl.

HPS.HighlightControl Highlight (HPS.SearchResults in_items, HPS.HighlightOptionsKit in_options)

Highlight the specified search results using the specified highlight options.

Param in_options:
Param in_items:	The search results to highlight. If there are invalid keys in the selection results, an exception will be thrown.
	The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
Return:	A reference to this HighlightControl.

HPS.HighlightControl Highlight (HPS.SearchResults in_items, HPS.HighlightOptionsKit in_options, bool in_remove_existing)

Highlight the specified search results using the specified highlight options.

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

HPS.HighlightControl Highlight (HPS.SelectionItem in_item, HPS.HighlightOptionsKit in_options)

Highlight the specified selection item using the specified highlight options.

Param in_options:
Param in_item:	The selection item to highlight. If the selection item is invalid, an exception will be thrown.
	The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
Return:	A reference to this HighlightControl.

HPS.HighlightControl Highlight (HPS.SelectionItem in_item, HPS.HighlightOptionsKit in_options, bool in_remove_existing)

Highlight the specified selection item using the specified highlight options.

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

HPS.HighlightControl Highlight (HPS.SelectionResults in_items, HPS.HighlightOptionsKit in_options)

Highlight the specified selection results using the specified highlight options.

Param in_options:
Param in_items:	The selection results to highlight. If there are invalid selection items in the selection results, an exception will be thrown.
	The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
Return:	A reference to this HighlightControl.

HPS.HighlightControl Highlight (HPS.SelectionResults in_items, HPS.HighlightOptionsKit in_options, bool in_remove_existing)

Highlight the specified selection results using the specified highlight options.

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

HighlightControl (HPS.HighlightControl in_that)

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

Param in_that:	The source HighlightControl to copy.

HighlightControl (HPS.WindowKey in_window)

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

Param in_window:
	The window which this HighlightControl should operate on.

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return:	The declared type of the object in question, which may differ from the true, underlying type.

void ShowHighlightState (HPS.Key in_key, HPS.HighlightSearchOptionsKit in_search_options, out HPS.HighlightState out_state)

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

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

void ShowHighlightState (HPS.KeyPath in_key_path, HPS.HighlightSearchOptionsKit in_search_options, out HPS.HighlightState out_state)

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

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

void ShowHighlightStates (HPS.Key[] in_keys, HPS.HighlightSearchOptionsKit in_search_options, out HPS.HighlightState[] out_states)

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

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

void ShowHighlightStates (HPS.KeyPath[] in_key_paths, HPS.HighlightSearchOptionsKit in_search_options, out HPS.HighlightState[] out_states)

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

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

HPS.HighlightControl Unhighlight (HPS.HighlightOptionsKit in_options)

Unhighlight geometry which was highlighted with the specified HighlightOptionsKit.

Param in_options:
	The highlight options to be removed.
Return:	A reference to this HighlightControl.

HPS.HighlightControl Unhighlight (HPS.Key in_item)

Unhighlight the specified key by removing the specified highlight options.

Param in_item:	The key to unhighlight. If the key is invalid, an exception will be thrown..
Return:	A reference to this HighlightControl.

HPS.HighlightControl Unhighlight (HPS.Key in_item, HPS.HighlightOptionsKit in_options)

Unhighlight the specified key by removing the specified highlight options.

Param in_options:
Param in_item:	The key to unhighlight. If the key is invalid, an exception will be thrown..
	The highlight options to be removed. Defaults to an empty HighlightOptionsKit.
Return:	A reference to this HighlightControl.

HPS.HighlightControl Unhighlight (HPS.Key in_item, HPS.HighlightOptionsKit in_options, ulong[] in_vertices, ulong[] in_edges1, ulong[] in_edges2, ulong[] in_faces)

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

Param in_options:
Param in_item:	The key to unhighlight. If the key is invalid, an exception will be thrown..
	The highlight options to be removed. Defaults to an empty HighlightOptionsKit.
Param in_vertices:
	An array of vertex indices, specifying vertices to unhighlight.
Param 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.
Param in_edges2:
	An array of vertex indices to be paired with entries in in_edges1 array to define the edge list.
Param in_faces:	An array of faces indices specifying faces to unhighlight.
Return:	A reference to this HighlightControl.

HPS.HighlightControl Unhighlight (HPS.KeyPath in_item)

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

Param in_item:	The key path to unhighlight. If there are no keys or invalid keys in the key path, an exception will be thrown.
Return:	A reference to this HighlightControl.

HPS.HighlightControl Unhighlight (HPS.KeyPath in_item, HPS.HighlightOptionsKit in_options)

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

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

HPS.HighlightControl Unhighlight (HPS.KeyPath in_item, HPS.HighlightOptionsKit in_options, ulong[] in_vertices, ulong[] in_edges1, ulong[] in_edges2, ulong[] in_faces)

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

Param in_options:
Param in_item:	The key path to unhighlight. If there are no keys or invalid keys in the key path, an exception will be thrown.
	The highlight options to be removed. Defaults to an empty HighlightOptionsKit.
Param in_vertices:
	An array of vertex indices, specifying vertices to unhighlight.
Param 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.
Param in_edges2:
	An array of vertex indices to be paired with entries in in_edges1 array to define the edge list.
Param in_faces:	An array of faces indices specifying faces to unhighlight.
Return:	A reference to this HighlightControl.

HPS.HighlightControl Unhighlight (HPS.SearchResults in_items)

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

Param in_items:	The search results to unhighlight. If there are invalid keys in the search results, an exception will be thrown.
Return:	A reference to this HighlightControl.

HPS.HighlightControl Unhighlight (HPS.SearchResults in_items, HPS.HighlightOptionsKit in_options)

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

Param in_options:
Param in_items:	The search results to unhighlight. If there are invalid keys in the search results, an exception will be thrown.
	The highlight options to be removed. Defaults to an empty HighlightOptionsKit.
Return:	A reference to this HighlightControl.

HPS.HighlightControl Unhighlight (HPS.SelectionItem in_item)

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

Param in_item:	The selection item to unhighlight. If the selection item is invalid, an exception will be thrown.
Return:	A reference to this HighlightControl.

HPS.HighlightControl Unhighlight (HPS.SelectionItem in_item, HPS.HighlightOptionsKit in_options)

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

Param in_options:
Param in_item:	The selection item to unhighlight. If the selection item is invalid, an exception will be thrown.
	The highlight options to be removed. Defaults to an empty HighlightOptionsKit.
Return:	A reference to this HighlightControl.

HPS.HighlightControl Unhighlight (HPS.SelectionResults in_items)

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

Param in_items:	The selection results to unhighlight. If there are invalid selection items in the selection results, an exception will be thrown.
Return:	A reference to this HighlightControl.

HPS.HighlightControl Unhighlight (HPS.SelectionResults in_items, HPS.HighlightOptionsKit in_options)

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

Param in_options:
Param in_items:	The selection results to unhighlight. If there are invalid selection items in the selection results, an exception will be thrown.
	The highlight options to be removed. Defaults to an empty HighlightOptionsKit.
Return:	A reference to this HighlightControl.

HPS.HighlightControl UnhighlightEverything ()

Unhighlight everything in the window associated with this HighlightControl.

Return:	A reference to this HighlightControl.

HighlightControl

Hello! I'm HOOPSY