FilteringExtension
The default filtering functionality is exposed as an extension. The current filtering implementation works by providing an updated FilteringState after each call to its functions. You can use this filtering state to keep track of filtering state.
Accessors
filteringState
Returns the current FilteringState.
Returns: FilteringState
Methods
hideObjects
Hides the specified object ids.
Parameters
- objectIds: The ids of the objects to hide
- optional stateKey: A way of splitting up commands coming from different controls (model explorer, filters, selection) so the viewer filtering api can know whether to reset its internal state or not
- optional includeDescendants: Whether to include the descendants of the provided object ids
- optional ghost Whether to ghost the rest of the objects
Returns: FilteringState
isolateObjects
Hides the specified object ids.
Parameters
- objectIds: The ids of the objects to hide
- optional stateKey: A way of splitting up commands coming from different controls (model explorer, filters, selection) so the viewer filtering api can know whether to reset its internal state or not
- optional includeDescendants: Whether to include the descendants of the provided object ids
- optional ghost Whether to ghost the rest of the objects
Returns: FilteringState
isolateObjects
Removes any current color filters.
Returns: FilteringState
removeUserObjectColors
Removes any current user color filters.
Returns: FilteringState
resetFilters
Removes al the current filters.
Returns: FilteringState
setColorFilter
Applies a color filter.
Parameters
- prop: PropertyInfo
- optional ghost” Whether to ghost the rest of the objects
Returns: FilteringState
setUserObjectColors
Applies a user color filter.
If used appropriately user color filters can typically be much more performant than applying multiple materials per color.
Parameters
- groups: Groups of objects organized by color
Returns: FilteringState
showObjects
Shows the specified object ids.
Parameters
- objectIds: The ids of the objects to hide
- optional stateKey: A way of splitting up commands coming from different controls (model explorer, filters, selection) so the viewer filtering api can know whether to reset its internal state or not
- optional includeDescendants: Whether to include the descendants of the provided object ids
Returns: FilteringState
unIsolateObjects
Shows the specified object ids.
Parameters
- objectIds: The ids of the objects to hide
- optional stateKey: A way of splitting up commands coming from different controls (model explorer, filters, selection) so the viewer filtering api can know whether to reset its internal state or not
- optional includeDescendants: Whether to include the descendants of the provided object ids
- optional ghost Whether to ghost the rest of the objects
Returns: FilteringState
Typedefs
FilteringState
- selectedObjects: The current selected object ids
- hidenObjects: The current hidden object ids
- isolatedObjects: The current isolated object ids
- colorGroups: The current color groups
- userColorGroups: The current user color groups
- activePropFilterKey: The active property filtering key
- passMin: The minimal value of the property filtering value if numeric
- passMax: The maximum value of the property filtering value if numeric
PropertyInfo
Outline of a filterable property.
- key: The property key
- objectCount: The object count where the key is present
- type: Property type