Locator
Introduction
vtkLocator is an abstract base class for spatial search objects, or locators. The principle behind locators is that they divide 3-space into small regions (or "buckets") that can be quickly found in response to queries about point location, line intersection, or object-object intersection.
Methods
extend
Method use to decorate a given object (publicAPI+model) with vtkLocator characteristics.
| Argument | Type | Required | Description |
|---|---|---|---|
publicAPI | Yes | object on which methods will be bounds (public) | |
model | Yes | object on which data structure will be bounds (protected) | |
initialValues | ILocatorInitialValues | No | (default: {}) |
getAutomatic
Get whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.
getDataSet
Get the dataset associated with this locator.
Returns
| Type | Description |
|---|---|
| vtkDataSet | The dataset associated with this locator. |
getLevel
Get the current level of the locator.
Returns
| Type | Description |
|---|---|
| Number | The current level of the locator. |
getMaxLevel
Get the maximum level of the locator.
Returns
| Type | Description |
|---|---|
| Number | The maximum level of the locator. |
getTolerance
Get the tolerance used for the locator.
Returns
| Type | Description |
|---|---|
| Number | The tolerance value. |
getUseExistingSearchStructure
Get whether to use an existing search structure.
Returns
| Type | Description |
|---|---|
| Boolean | Whether an existing search structure is used. |
setAutomatic
Set whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.
| Argument | Type | Required | Description |
|---|---|---|---|
automatic | Boolean | Yes | - The automatic flag. |
Returns
| Type | Description |
|---|---|
| Boolean | Whether the operation was successful. |
setDataSet
Set the dataset associated with this locator.
| Argument | Type | Required | Description |
|---|---|---|---|
dataSet | vtkDataSet | Yes | - The dataset to associate with this locator. |
Returns
| Type | Description |
|---|---|
| Boolean | Whether the operation was successful. |
setLevel
Set the current level of the locator.
| Argument | Type | Required | Description |
|---|---|---|---|
level | Number | Yes | - The level to set. |
Returns
| Type | Description |
|---|---|
| Boolean | Whether the operation was successful. |
setMaxLevel
Set the maximum level of the locator.
| Argument | Type | Required | Description |
|---|---|---|---|
maxLevel | Number | Yes | - The maximum level to set. |
Returns
| Type | Description |
|---|---|
| Boolean | Whether the operation was successful. |
setTolerance
Set the tolerance used for the locator.
| Argument | Type | Required | Description |
|---|---|---|---|
tolerance | Number | Yes | - The tolerance value to set. |
Returns
| Type | Description |
|---|---|
| Boolean | Whether the operation was successful. |
setUseExistingSearchStructure
Set whether to use an existing search structure.
| Argument | Type | Required | Description |
|---|---|---|---|
useExistingSearchStructure | Boolean | Yes | - Whether to use an existing search structure. |
Returns
| Type | Description |
|---|---|
| Boolean | Whether the operation was successful. |