ThreeDFormat
ThreeDFormat class
Represents a shape’s three-dimensional formatting.
class ThreeDFormat;
Properties
| Property | Type | Description |
|---|---|---|
| bottomBevelWidth | number | Gets and sets the width of the bottom bevel, or how far into the shape it is applied. In unit of Points. |
| bottomBevelHeight | number | Gets and sets the height of the bottom bevel, or how far into the shape it is applied. In unit of Points. |
| bottomBevelType | BevelType | Gets and sets the type of the bottom bevel, or how far into the shape it is applied. In unit of Points. |
| topBevelWidth | number | Gets and sets the width of the top bevel, or how far into the shape it is applied. In unit of Points. |
| topBevelHeight | number | Gets and sets the height of the top bevel, or how far into the shape it is applied. In unit of Points. |
| topBevelType | BevelType | Gets and sets the type of the top bevel, or how far into the shape it is applied. In unit of Points. |
| material | PresetMaterialType | Represents the preset material which is combined with the lighting properties to give the final look and feel of a shape. |
| contourColor | CellsColor | Gets and sets the contour color on a shape. |
| contourWidth | number | Gets and sets the contour width on the shape, in unit of points. |
| extrusionColor | CellsColor | Gets the extrusion color on a shape. |
| extrusionHeight | number | Gets and sets the extrusion height of the applied to the shape, in unit of points. |
| z | number | Defines the distance from ground for the 3D shape. |
| lightAngle | number | Gets and sets the angle of the extrusion lights. |
| lighting | LightRigType | Gets and sets type of light rig. |
| lightingDirection | LightRigDirectionType | Gets and sets the direction from which the light rig is oriented in relation to the scene. |
| perspective | number | Gets and sets the angle at which a ThreeDFormat object can be viewed. |
| rotationX | number | Gets and sets the rotation of the extruded shape around the x-axis in degrees. |
| rotationY | number | Gets and sets the rotation of the extruded shape around the y-axis in degrees. |
| rotationZ | number | Gets and sets the rotation of the extruded shape around the z-axis in degrees. |
| presetCameraType | PresetCameraType | Gets and sets the extrusion preset camera type. |
Methods
| Method | Description |
|---|---|
| getHashCode() | Gets hashcode. |
| equals(VObject) |
bottomBevelWidth
Gets and sets the width of the bottom bevel, or how far into the shape it is applied. In unit of Points.
bottomBevelWidth : number;
bottomBevelHeight
Gets and sets the height of the bottom bevel, or how far into the shape it is applied. In unit of Points.
bottomBevelHeight : number;
bottomBevelType
Gets and sets the type of the bottom bevel, or how far into the shape it is applied. In unit of Points.
bottomBevelType : BevelType;
topBevelWidth
Gets and sets the width of the top bevel, or how far into the shape it is applied. In unit of Points.
topBevelWidth : number;
topBevelHeight
Gets and sets the height of the top bevel, or how far into the shape it is applied. In unit of Points.
topBevelHeight : number;
topBevelType
Gets and sets the type of the top bevel, or how far into the shape it is applied. In unit of Points.
topBevelType : BevelType;
material
Represents the preset material which is combined with the lighting properties to give the final look and feel of a shape.
material : PresetMaterialType;
contourColor
Gets and sets the contour color on a shape.
contourColor : CellsColor;
contourWidth
Gets and sets the contour width on the shape, in unit of points.
contourWidth : number;
extrusionColor
Gets the extrusion color on a shape.
extrusionColor : CellsColor;
extrusionHeight
Gets and sets the extrusion height of the applied to the shape, in unit of points.
extrusionHeight : number;
z
Defines the distance from ground for the 3D shape.
z : number;
lightAngle
Gets and sets the angle of the extrusion lights.
lightAngle : number;
lighting
Gets and sets type of light rig.
lighting : LightRigType;
lightingDirection
Gets and sets the direction from which the light rig is oriented in relation to the scene.
lightingDirection : LightRigDirectionType;
perspective
Gets and sets the angle at which a ThreeDFormat object can be viewed.
perspective : number;
rotationX
Gets and sets the rotation of the extruded shape around the x-axis in degrees.
rotationX : number;
rotationY
Gets and sets the rotation of the extruded shape around the y-axis in degrees.
rotationY : number;
rotationZ
Gets and sets the rotation of the extruded shape around the z-axis in degrees.
rotationZ : number;
presetCameraType
Gets and sets the extrusion preset camera type.
presetCameraType : PresetCameraType;
getHashCode()
Gets hashcode.
getHashCode() : number;
equals(VObject)
equals(obj: VObject) : boolean;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | VObject |