ThreeDFormat

ThreeDFormat class

Represents a shape’s three-dimensional formatting.

class ThreeDFormat;

Properties

PropertyTypeDescription
bottomBevelWidthnumberGets and sets the width of the bottom bevel, or how far into the shape it is applied. In unit of Points.
bottomBevelHeightnumberGets and sets the height of the bottom bevel, or how far into the shape it is applied. In unit of Points.
bottomBevelTypeBevelTypeGets and sets the type of the bottom bevel, or how far into the shape it is applied. In unit of Points.
topBevelWidthnumberGets and sets the width of the top bevel, or how far into the shape it is applied. In unit of Points.
topBevelHeightnumberGets and sets the height of the top bevel, or how far into the shape it is applied. In unit of Points.
topBevelTypeBevelTypeGets and sets the type of the top bevel, or how far into the shape it is applied. In unit of Points.
materialPresetMaterialTypeRepresents the preset material which is combined with the lighting properties to give the final look and feel of a shape.
contourColorCellsColorGets and sets the contour color on a shape.
contourWidthnumberGets and sets the contour width on the shape, in unit of points.
extrusionColorCellsColorGets the extrusion color on a shape.
extrusionHeightnumberGets and sets the extrusion height of the applied to the shape, in unit of points.
znumberDefines the distance from ground for the 3D shape.
lightAnglenumberGets and sets the angle of the extrusion lights.
lightingLightRigTypeGets and sets type of light rig.
lightingDirectionLightRigDirectionTypeGets and sets the direction from which the light rig is oriented in relation to the scene.
perspectivenumberGets and sets the angle at which a ThreeDFormat object can be viewed.
rotationXnumberGets and sets the rotation of the extruded shape around the x-axis in degrees.
rotationYnumberGets and sets the rotation of the extruded shape around the y-axis in degrees.
rotationZnumberGets and sets the rotation of the extruded shape around the z-axis in degrees.
presetCameraTypePresetCameraTypeGets and sets the extrusion preset camera type.

Methods

MethodDescription
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:

ParameterTypeDescription
objVObject