Class Effect3D
Inheritance
System.Object
Effect3D
Assembly: IronPPT.dll
Syntax
public class Effect3D : Object
Three-dimensional depth on a shape, the bevels, extrusion, and contour that make a box read as raised or carved, is described by Effect3D. Apply one when a slide element needs a material, lit appearance rather than a flat fill, and reach for the static DefaultEffect when a sensible starting effect is enough.
An Effect3D is attached to a shape's style and then tuned property by property. BevelTop and BevelBottom each take a Bevel that shapes the raised top and bottom edges, while ContourColor and ContourWidth outline the form and ExtrusionColor with ExtrusionHeight push it back into apparent depth. PresetMaterialType, a PresetMaterialTypeValues, selects the surface finish so the same geometry can look like plastic, metal, or matte under the slide's lighting.
Width and height values are plain double properties measured in the library's internal unit, so set them through the unit-aware helpers when working in a specific measurement. SetContourWidth and SetExtrusionHeight each accept a value plus a Units, and GetContourWidth and GetExtrusionHeight read the values back in the Units you ask for, which keeps your code in points or centimeters even though the stored value is unit-agnostic. Start from Effect3D.DefaultEffect to get a balanced result, then override only the properties a design calls for rather than building every value from zero. Because the bevels are described by the separate Bevel type, adjust an edge by configuring that object and assigning it to BevelTop or BevelBottom. For the slide elements this effect decorates, the shape and styling workflow is the place to begin.
using IronPPT.Models;
using IronPPT.Enums;
var effect = Effect3D.DefaultEffect;
effect.PresetMaterialType = PresetMaterialTypeValues.Metal;
effect.SetExtrusionHeight(6, Units.Point);
The add shape example places a shape on a slide, the slide element tutorial walks through styling elements on a slide, and the Bevel reference details the edge object the bevel properties accept.
Constructors
Effect3D()
Declaration
Fields
DefaultEffect
Declaration
public static Effect3D DefaultEffect
Field Value
Properties
BevelBottom
Declaration
public Bevel BevelBottom { get; set; }
Property Value
BevelTop
Declaration
public Bevel BevelTop { get; set; }
Property Value
ContourColor
Declaration
public Color ContourColor { get; set; }
Property Value
ContourWidth
Declaration
public double ContourWidth { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
ExtrusionColor
Declaration
public Color ExtrusionColor { get; set; }
Property Value
ExtrusionHeight
Declaration
public double ExtrusionHeight { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
PresetMaterialType
Declaration
public PresetMaterialTypeValues PresetMaterialType { get; set; }
Property Value
Methods
GetContourWidth(Units)
Declaration
public double GetContourWidth(Units measurementUnit)
Parameters
| Type |
Name |
Description |
| Units |
measurementUnit |
|
Returns
| Type |
Description |
| System.Double |
|
GetExtrusionHeight(Units)
Declaration
public double GetExtrusionHeight(Units measurementUnit)
Parameters
| Type |
Name |
Description |
| Units |
measurementUnit |
|
Returns
| Type |
Description |
| System.Double |
|
SetContourWidth(Double, Units)
Declaration
public void SetContourWidth(double contourWidth, Units measurementUnit)
Parameters
| Type |
Name |
Description |
| System.Double |
contourWidth |
|
| Units |
measurementUnit |
|
SetExtrusionHeight(Double, Units)
Declaration
public void SetExtrusionHeight(double height, Units measurementUnit)
Parameters
| Type |
Name |
Description |
| System.Double |
height |
|
| Units |
measurementUnit |
|