Autodesk.Viewing.ViewingUtilities
Methods
activatePivot(fadeIt)
This method activates the in scene pivot indicator. The pivot is positioned at the current camera’s pivot point.
Parameters
| fadeIt* boolean | If true the indicator will be displayed and then fade away after a short period. |
See
fitToView(immediate)
Request a camera transition to fit the current model or model selection into the view frustum.
Parameters
| immediate* boolean | If true the transition will be immediate, otherwise animated over a short time period. |
Returns
| Type | Description |
|---|---|
| object |
|
getBoundingBox(ignoreSelection)
Return the bounding box of the current model or model selection.
Parameters
| ignoreSelection* boolean | If true the current selection is ignored and the model bounds is returned. |
Returns
| Type | Description |
|---|---|
| THREE.Box3 |
getHitPoint(x,y)
This method performs a hit test with the current model using a ray cast from the given screen coordinates.
Parameters
| x* number | The normalized screen x coordinate in [0, 1]. |
| y* number | The normalized screen y coordinate in [0, 1]. |
Returns
| Type | Description |
|---|---|
| THREE.Vector3 | The world space hit position or null if no object was hit. |
goHome()
This method triggers a camera view transition to the registered home view for the current scene.
pivotActive(state,fadeIt)
This method changes the display state of the in scene pivot indicator. If the current scene is 2D this method has no effect.
Parameters
| state* boolean | The requested display state for the indicator. |
| fadeIt* boolean | If true and “state” is also true, the indicator will be displayed and then fade away after a short period. |
See
pivotUpdate()
Invoke this method to refresh the pivot indicator and continue its fading action if required.
removeTemporaryPivot()
Restore a pivot value that was saved by a call to setTemporary Pivot.
restorePivot(name)
Restore the saved copy of the current pivot point and pivot set flag. Once restored the saved value is erased.
Parameters
| name* string | Optional unique name of the saved location. |
savePivot(name)
Save a copy of the current pivot point and pivot set flag.
Parameters
| name* string | Optional unique name of the saved location. |
setColor()
Change pivot color. Example, red is 0xFF0000
setPivotColor(color,opacity)
Change pivot color and opacity. Example, to get red 100% solid (non-transparent) use setPivotColor(0xFF0000, 1)
Parameters
| color* Number | RBG Hex color. |
| opacity Number | Opacity value from 0 (transparent) to 1 (opaque). |
setPivotPoint(newPivot,preserveView,isset)
Set the current pivot point and pivot set flag. If the pivot indicator is active its position will be updated accordingly. If a temporary pivot was previously applied, its saved state will be cleared.
Parameters
| newPivot* THREE.Vector3 | The world space position of the new pivot point. |
| preserveView* boolean | If false the camera’s view direction will change to look at the new pivot point. If true the camera’s view will not be changed. |
| isset* boolean | The new state of the pivot set flag. |
See
setPivotSize(scale)
Changes the pivot graphic size.
Parameters
| scale* Number | Default size value is 1 |
setSize()
Changes the pivot graphic size. Set default size with scale value of 1.
setTemporaryPivot(newPivot)
Allows the caller to save the current pivot and replace it with a new location. If while the temporary pivot is active a new pivot is set via the setPivotPoint method, the saved pivot will be cleared to avoid restoring an out of date pivot location.
Parameters
| newPivot* THREE.Vector3 | The new pivot to be assigned or null to clear any previously saved pivot. |
transitionView(pos,coi,fov,up,worldUp,reorient,pivot)
This method triggers a camera view transition as specified by the parameters.
Parameters
| pos* THREE.Vector3 | The new world space position of the camera. |
| coi* THREE.Vector3 | The new center of interest (look at point). |
| fov* number | The new field of view for the camera in degrees. |
| up* THREE.Vector3 | The new camera up direction. |
| worldUp* THREE.Vector3 | The new world up direction. |
| reorient* boolean | If true the given camera up parameter is ignored and a new up direction will be calculated to be aligned with the given world up direction. |
| pivot* THREE.Vector3 | The new pivot point. |
