Object extension methods in 3D View
- Last UpdatedOct 29, 2025
- 2 minute read
These API methods are used to to create 3D objects and their manipulations in the Engage 3D model.
Create object
To place a 3D object in the Engage 3D model view.
[{"ObjectId":"symbol1","ObjectShape":0,"Position":{"X":-311000.35,"Y":298628.81,"Z":109961.97},"Color":"Blue","ScaleFactor":{"X":1.0,"Y":1.0,"Z":1.0}}]
-
ObjectId: The unique name or ID of the object to be placed.
-
ObjectShape: Sphere, if value is 0. Cube, if value is 1. For Sphere, you will need to add new Radius parameter, but Scale Factor is not required.
-
Position: 3D coordinate of the object to be placed
-
Color: The color of the object.
-
ScaleFactor: X,Y,Z scaling parameter of the object.
Note: For a Sphere object, you need to pass a Radius param. For other objects, it’s not required.
Example—Code sample with Radius param
[{"ObjectId":"symbol1","ObjectShape":0,"Position":{"X":-311000.35,"Y":298628.81,"Z":109961.97},"Color":"Blue","ScaleFactor":{"X":1.0,"Y":1.0,"Z":1.0},"Radius":500}]
Highlight object
Highlights the 3D object placed in model. ObjectId should be passed as parameter.
Set color to object
Sets a specified color to object.
{"ObjectId":"symbol1","Color":"Red"}
Zoom to object
Zooms to the 3D object placed in model. ObjectId should be passed as parameter.
Set position of object
Gives a new position to 3D object.
{"ObjectId":"symbol1","Position":{"X":-311000.35,"Y":298628.81,"Z":109000.97}}
Get position of object
Gets the position of 3D object on model. ObjectId should be passed as parameter.
Hide object
Hides an object on the model. ObjectId should be passed as parameter.
Show object
Shows a hidden object on the model. ObjectId should be passed as parameter.
Delete object
Deletes the 3D object on the model.ObjectId should be passed as parameter.
Set camera position
Sets the camera at a certain position.
{"X":-311000.35,"Y":298628.81,"Z":109961.97}
Set camera position by distance
Sets the camera at a distance from a specified point.
{"Position":{"X":-311000.35,"Y":298628.81,"Z":109961.97},"Distance":10000.0}
Look towards position
Makes the camera look (rotate) towards a specified point without changing the current camera position.
{"X":-311000.35,"Y":298628.81,"Z":109961.97}
Set camera direction
Sets the camera to a direction (vector).
{"X":-468.33,"Y":9291.70,"Z":-2049.195}
Get camera position
Returns current position coordinates of the camera.
Get camera direction
Returns a normalized vector of camera direction.
Set camera position and direction
Moves the camera to a certain position (point3D), while changing the camera direction to a specified direction (vector).
Set camera position and look towards
Moves the camera to a certain position (point3D), while making camera look at a given position (point3D).
Get current cache information
Returns currently loaded model information to Engage extensions web view.