Format3D
Format3D class
This class specifies the 3D shape properties for a chart element or shape.
class Format3D;
Methods
| Method | Description |
|---|---|
| getTopBevel() | Gets the Bevel object that holds the properties associated with defining a bevel on the top or front face of a shape. |
| getSurfaceMaterialType() | Gets and sets the material type which is combined with the lighting properties to give the final look and feel of a shape. Default value is PresetMaterialType.WarmMatte. |
| setSurfaceMaterialType(PresetMaterialType) | Gets and sets the material type which is combined with the lighting properties to give the final look and feel of a shape. Default value is PresetMaterialType.WarmMatte. |
| getSurfaceLightingType() | Gets and sets the lighting type which is to be applied to the scene of the shape. Default value is LightRigType.ThreePoint. |
| setSurfaceLightingType(LightRigType) | Gets and sets the lighting type which is to be applied to the scene of the shape. Default value is LightRigType.ThreePoint. |
| getLightingAngle() | Gets and sets the lighting angle. Range from 0 to 359.9 degrees. |
| setLightingAngle(number) | Gets and sets the lighting angle. Range from 0 to 359.9 degrees. |
| hasTopBevelData() | Indicates if the shape has top bevel data. |
| isNull() | Checks whether the implementation object is null. |
getTopBevel()
Gets the Bevel object that holds the properties associated with defining a bevel on the top or front face of a shape.
getTopBevel() : Bevel;
Returns
getSurfaceMaterialType()
Gets and sets the material type which is combined with the lighting properties to give the final look and feel of a shape. Default value is PresetMaterialType.WarmMatte.
getSurfaceMaterialType() : PresetMaterialType;
Returns
setSurfaceMaterialType(PresetMaterialType)
Gets and sets the material type which is combined with the lighting properties to give the final look and feel of a shape. Default value is PresetMaterialType.WarmMatte.
setSurfaceMaterialType(value: PresetMaterialType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PresetMaterialType | The value to set. |
getSurfaceLightingType()
Gets and sets the lighting type which is to be applied to the scene of the shape. Default value is LightRigType.ThreePoint.
getSurfaceLightingType() : LightRigType;
Returns
setSurfaceLightingType(LightRigType)
Gets and sets the lighting type which is to be applied to the scene of the shape. Default value is LightRigType.ThreePoint.
setSurfaceLightingType(value: LightRigType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | LightRigType | The value to set. |
getLightingAngle()
Gets and sets the lighting angle. Range from 0 to 359.9 degrees.
getLightingAngle() : number;
setLightingAngle(number)
Gets and sets the lighting angle. Range from 0 to 359.9 degrees.
setLightingAngle(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
hasTopBevelData()
Indicates if the shape has top bevel data.
hasTopBevelData() : boolean;
isNull()
Checks whether the implementation object is null.
isNull() : boolean;