|
override void | Dispose () |
|
HPS.HighlightControl | Highlight (HPS.SelectionResults in_items, HPS.HighlightOptionsKit in_options, bool in_remove_existing) |
|
HPS.HighlightControl | Highlight (HPS.SelectionResults in_items, HPS.HighlightOptionsKit in_options) |
|
HPS.HighlightControl | Highlight (HPS.SelectionItem in_item, HPS.HighlightOptionsKit in_options, bool in_remove_existing) |
|
HPS.HighlightControl | Highlight (HPS.SelectionItem in_item, HPS.HighlightOptionsKit in_options) |
|
HPS.HighlightControl | Highlight (HPS.SearchResults in_items, HPS.HighlightOptionsKit in_options, bool in_remove_existing) |
|
HPS.HighlightControl | Highlight (HPS.SearchResults in_items, HPS.HighlightOptionsKit in_options) |
|
HPS.HighlightControl | Highlight (HPS.KeyPath in_item, HPS.HighlightOptionsKit in_options, bool in_remove_existing) |
|
HPS.HighlightControl | Highlight (HPS.KeyPath in_item, HPS.HighlightOptionsKit in_options) |
|
HPS.HighlightControl | Highlight (HPS.Key in_item, HPS.HighlightOptionsKit in_options, bool in_remove_existing) |
|
HPS.HighlightControl | Highlight (HPS.Key in_item, HPS.HighlightOptionsKit in_options) |
|
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) |
|
HPS.HighlightControl | Highlight (HPS.KeyPath in_item, HPS.HighlightOptionsKit in_options, ulong[] in_vertices, ulong[] in_edges1, ulong[] in_edges2, ulong[] in_faces) |
|
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) |
|
HPS.HighlightControl | Highlight (HPS.Key in_item, HPS.HighlightOptionsKit in_options, ulong[] in_vertices, ulong[] in_edges1, ulong[] in_edges2, ulong[] in_faces) |
|
| HighlightControl (HPS.WindowKey in_window) |
|
| HighlightControl (HPS.HighlightControl in_that) |
|
override HPS.Type | ObjectType () |
|
void | ShowHighlightState (HPS.Key in_key, HPS.HighlightSearchOptionsKit in_search_options, out HPS.HighlightState out_state) |
|
void | ShowHighlightState (HPS.KeyPath in_key_path, HPS.HighlightSearchOptionsKit in_search_options, out HPS.HighlightState out_state) |
|
void | ShowHighlightStates (HPS.Key[] in_keys, HPS.HighlightSearchOptionsKit in_search_options, out HPS.HighlightState[] out_states) |
|
void | ShowHighlightStates (HPS.KeyPath[] in_key_paths, HPS.HighlightSearchOptionsKit in_search_options, out HPS.HighlightState[] out_states) |
|
override HPS.Type | Type () |
|
HPS.HighlightControl | Unhighlight (HPS.SelectionResults in_items, HPS.HighlightOptionsKit in_options) |
|
HPS.HighlightControl | Unhighlight (HPS.SelectionResults in_items) |
|
HPS.HighlightControl | Unhighlight (HPS.SelectionItem in_item, HPS.HighlightOptionsKit in_options) |
|
HPS.HighlightControl | Unhighlight (HPS.SelectionItem in_item) |
|
HPS.HighlightControl | Unhighlight (HPS.SearchResults in_items, HPS.HighlightOptionsKit in_options) |
|
HPS.HighlightControl | Unhighlight (HPS.SearchResults in_items) |
|
HPS.HighlightControl | Unhighlight (HPS.KeyPath in_item, HPS.HighlightOptionsKit in_options) |
|
HPS.HighlightControl | Unhighlight (HPS.KeyPath in_item) |
|
HPS.HighlightControl | Unhighlight (HPS.Key in_item, HPS.HighlightOptionsKit in_options) |
|
HPS.HighlightControl | Unhighlight (HPS.Key in_item) |
|
HPS.HighlightControl | Unhighlight (HPS.KeyPath in_item, HPS.HighlightOptionsKit in_options, ulong[] in_vertices, ulong[] in_edges1, ulong[] in_edges2, ulong[] in_faces) |
|
HPS.HighlightControl | Unhighlight (HPS.Key in_item, HPS.HighlightOptionsKit in_options, ulong[] in_vertices, ulong[] in_edges1, ulong[] in_edges2, ulong[] in_faces) |
|
HPS.HighlightControl | Unhighlight (HPS.HighlightOptionsKit in_options) |
|
HPS.HighlightControl | UnhighlightEverything () |
|
| Control (HPS.Control in_that) |
|
virtual bool | Empty () |
|
IntPtr | GetClassID () |
|
IntPtr | GetInstanceID () |
|
bool | HasType (HPS.Type in_mask) |
|
| Object (HPS.Object that) |
|
virtual void | Reset () |
|
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ HighlightControl() [1/2]
This constructor creates a HighlightControl object which is tied to the specified window.
- Parameters
-
◆ HighlightControl() [2/2]
◆ Highlight() [1/14]
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/14]
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. |
- Returns
- A reference to this HighlightControl.
◆ Highlight() [3/14]
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() [4/14]
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. |
- Returns
- A reference to this HighlightControl.
◆ Highlight() [5/14]
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() [6/14]
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. |
- Returns
- A reference to this HighlightControl.
◆ Highlight() [7/14]
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() [8/14]
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. |
- Returns
- A reference to this HighlightControl.
◆ Highlight() [9/14]
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() [10/14]
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. |
- Returns
- A reference to this HighlightControl.
◆ Highlight() [11/14]
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() [12/14]
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. |
- Returns
- A reference to this HighlightControl.
◆ Highlight() [13/14]
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() [14/14]
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. |
- Returns
- A reference to this HighlightControl.
◆ ObjectType()
override HPS.Type HPS.HighlightControl.ObjectType |
( |
| ) |
|
|
inlinevirtual |
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).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Control.
◆ ShowHighlightState() [1/2]
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]
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]
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]
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()
override HPS.Type HPS.HighlightControl.Type |
( |
| ) |
|
|
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.
- Warning
- This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Control.
◆ Unhighlight() [1/13]
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/13]
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. |
- Returns
- A reference to this HighlightControl.
◆ Unhighlight() [3/13]
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() [4/13]
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. |
- Returns
- A reference to this HighlightControl.
◆ Unhighlight() [5/13]
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() [6/13]
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. |
- Returns
- A reference to this HighlightControl.
◆ Unhighlight() [7/13]
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() [8/13]
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. |
- Returns
- A reference to this HighlightControl.
◆ Unhighlight() [9/13]
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() [10/13]
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.. |
- Returns
- A reference to this HighlightControl.
◆ Unhighlight() [11/13]
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() [12/13]
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() [13/13]
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()
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.HighlightControl.cs