ShapeEffect3DProperties Class

Contains settings for 3D effects applied to a shape.

Declaration

public class ShapeEffect3DProperties extends OfficeObject

Remarks

The following code snippet configures the camera angle for 3D shape effects:

Java

import com.devexpress.docs.presentation.*;
import com.devexpress.docs.office.*;

// Configure the 3D camera position for shape effects.
ShapeEffect3DProperties effect3D = new ShapeEffect3DProperties();
effect3D.setCameraLatitude(20.0f);
effect3D.setCameraLongitude(30.0f);
effect3D.setCameraRevolution(45.0f);

// Create a rectangular shape.
Shape shape = new Shape(ShapeType.getRectangle(), 30, 30, 2000, 1000);

// Apply effects to the shape.
shape.getEffects().setEffect3D(effect3D);

// Get the first slide in the presentation.
Slide slide = presentation.getSlides().getFirst();

// Add the shape to the first slide.
slide.getShapes().add(shape);

Inherited Members

deepClone()

notifyChange(Object sender, String propertyName)

com.devexpress.system.JavaObject.clone()

com.devexpress.system.JavaObject.equals(java.lang.Object)

com.devexpress.system.JavaObject.hashCode()

com.devexpress.system.JavaObject.initFields()

com.devexpress.system.JavaObject.memberwiseClone()

com.devexpress.system.JavaObject.toString()

java.lang.Object.finalize()

java.lang.Object.getClass()

java.lang.Object.notify()

java.lang.Object.notifyAll()

java.lang.Object.wait()

java.lang.Object.wait(long)

java.lang.Object.wait(long,int)

Inheritance

Object

JavaObject

OfficeObject

ShapeEffect3DProperties

ShapeEffect3DProperties()

Initializes a new instance of the ShapeEffect3DProperties class.

Declaration

public ShapeEffect3DProperties()

Methods

deepClone() Method

Returns a deep copy of this ShapeEffect3DProperties instance.

Declaration

public ShapeEffect3DProperties deepClone()

Returns

Type	Description
ShapeEffect3DProperties	A deep copy of this ShapeEffect3DProperties.

getBackdropPlaneAnchorPoint() Method

Returns the anchor point of the backdrop plane.

Declaration

public Scene3DVector getBackdropPlaneAnchorPoint()

Returns

Type	Description
Scene3DVector	The anchor point of the backdrop plane.

Remarks

The following image depicts the backdrop plane elements - the anchor point, the normal vector, and the up vector:

getBackdropPlaneNormalVector() Method

Returns a vector that is perpendicular to the face of the backdrop plane.

Declaration

public Scene3DVector getBackdropPlaneNormalVector()

Returns

Type	Description
Scene3DVector	A vector that is perpendicular to the face of the backdrop plane.

Remarks

The following image depicts the backdrop plane elements - the anchor point, the normal vector, and the up vector:

getBackdropPlaneUpVector() Method

Returns a vector that defines the upward direction of the backdrop plane.

Declaration

public Scene3DVector getBackdropPlaneUpVector()

Returns

Type	Description
Scene3DVector	A vector that defines the upward direction of the backdrop plane.

Remarks

The following image depicts the backdrop plane elements - the anchor point, the normal vector, and the up vector:

getBottomBevelHeight() Method

Returns the height of the bottom bevel of a shape.

Declaration

public float getBottomBevelHeight()

Returns

Type	Description
float	The height of the bottom bevel of a shape.

getBottomBevelPreset() Method

Returns the preset type of the shape’s bottom bevel.

Declaration

public PresetBevelType getBottomBevelPreset()

Returns

Type	Description
PresetBevelType	The preset type of the shape’s bottom bevel.

getBottomBevelWidth() Method

Returns the width of the shape’s bottom bevel.

Declaration

public float getBottomBevelWidth()

Returns

Type	Description
float	The width of the shape’s bottom bevel.

getCameraFov() Method

Returns the camera field of view (FOV) angle in degrees.

Declaration

public float getCameraFov()

Returns

Type	Description
float	The camera field of view (FOV) angle in degrees.

getCameraLatitude() Method

Returns the camera latitude angle in degrees.

Declaration

public @Nullable Float getCameraLatitude()

Returns

Type	Description
	The camera latitude angle in degrees.

getCameraLongitude() Method

Returns the camera longitude angle in degrees.

Declaration

public @Nullable Float getCameraLongitude()

Returns

Type	Description
	The camera longitude angle in degrees.

getCameraPreset() Method

Returns the preset camera type.

Declaration

public PresetCameraType getCameraPreset()

Returns

Type	Description
PresetCameraType	The preset camera type.

getCameraRevolution() Method

Returns the camera revolution angle, in degrees, used to rotate the camera around the shape.

Declaration

public @Nullable Float getCameraRevolution()

Returns

Type	Description
	The camera revolution angle in degrees.

getCameraZoom() Method

Returns the camera zoom value.

Declaration

public float getCameraZoom()

Returns

Type	Description
float	The camera zoom value.

getContourColor() Method

Returns the shape contour color.

Declaration

public OfficeColor getContourColor()

Returns

Type	Description
OfficeColor	The shape contour color.

getContourWidth() Method

Returns the shape contour width.

Declaration

public float getContourWidth()

Returns

Type	Description
float	The shape contour width.

getExtrusionColor() Method

Returns the extrusion color applied to a shape. Extrusion adds artificial height to the shape’s geometry.

Declaration

public OfficeColor getExtrusionColor()

Returns

Type	Description
OfficeColor	The color of the extrusion applied to a shape.

getExtrusionHeight() Method

Returns the extrusion height applied to a shape. Extrusion adds artificial height to the shape’s geometry.

Declaration

public float getExtrusionHeight()

Returns

Type	Description
float	The height of the extrusion applied to a shape.

getLightRigDirection() Method

Returns the light rig direction.

Declaration

public LightRigDirection getLightRigDirection()

Returns

Type	Description
LightRigDirection	The light rig direction.

getLightRigLatitude() Method

Returns the light rig latitude.

Declaration

public @Nullable Float getLightRigLatitude()

Returns

Type	Description
	The light rig latitude angle in degrees.

getLightRigLongitude() Method

Returns the light rig longitude.

Declaration

public @Nullable Float getLightRigLongitude()

Returns

Type	Description
	The light rig longitude angle in degrees.

getLightRigPreset() Method

Returns the light rig preset.

Declaration

public LightRigPreset getLightRigPreset()

Returns

Type	Description
LightRigPreset	The light rig preset.

getLightRigRevolution() Method

Returns the light rig revolution angle, in degrees, used to rotate the light rig around the shape.

Declaration

public @Nullable Float getLightRigRevolution()

Returns

Type	Description
	The light rig revolution angle in degrees.

getPresetMaterial() Method

Returns the preset material applied to the shape.

Declaration

public PresetMaterialType getPresetMaterial()

Returns

Type	Description
PresetMaterialType	The preset material applied to the shape.

getShapeDepth() Method

Returns the shape depth.

Declaration

public float getShapeDepth()

Returns

Type	Description
float	The shape depth.

getTopBevelHeight() Method

Returns the height of the top bevel.

Declaration

public float getTopBevelHeight()

Returns

Type	Description
float	The height of the top bevel.

getTopBevelPreset() Method

Returns the top bevel preset.

Declaration

public PresetBevelType getTopBevelPreset()

Returns

Type	Description
PresetBevelType	The top bevel preset.

getTopBevelWidth() Method

Returns the width of the top bevel.

Declaration

public float getTopBevelWidth()

Returns

Type	Description
float	The width of the top bevel.

setBackdropPlaneAnchorPoint(Scene3DVector value) Method

Sets the anchor point of the backdrop plane.

Declaration

public void setBackdropPlaneAnchorPoint(Scene3DVector value)

Parameters

Name	Type	Description
value	Scene3DVector	The anchor point of the backdrop plane.

Remarks

The following image depicts the backdrop plane elements - the anchor point, the normal vector, and the up vector:

setBackdropPlaneNormalVector(Scene3DVector value) Method

Sets a vector that is perpendicular to the face of the backdrop plane.

Declaration

public void setBackdropPlaneNormalVector(Scene3DVector value)

Parameters

Name	Type	Description
value	Scene3DVector	A vector that is perpendicular to the face of the backdrop plane.

Remarks

The following image depicts the backdrop plane elements - the anchor point, the normal vector, and the up vector:

setBackdropPlaneUpVector(Scene3DVector value) Method

Sets a vector that defines the upward direction of the backdrop plane.

Declaration

public void setBackdropPlaneUpVector(Scene3DVector value)

Parameters

Name	Type	Description
value	Scene3DVector	A vector that defines the upward direction of the backdrop plane.

Remarks

The following image depicts the backdrop plane elements - the anchor point, the normal vector, and the up vector:

setBottomBevelHeight(float value) Method

Sets the height of the bottom bevel of a shape.

Declaration

public void setBottomBevelHeight(float value)

Parameters

Name	Type	Description
value	float	The height of the bottom bevel of a shape.

setBottomBevelPreset(PresetBevelType value) Method

Sets the preset type of the shape’s bottom bevel.

Declaration

public void setBottomBevelPreset(PresetBevelType value)

Parameters

Name	Type	Description
value	PresetBevelType	The preset type of the shape’s bottom bevel.

setBottomBevelWidth(float value) Method

Sets the width of the shape’s bottom bevel.

Declaration

public void setBottomBevelWidth(float value)

Parameters

Name	Type	Description
value	float	The width of the shape’s bottom bevel.

setCameraFov(float value) Method

Sets the camera field of view (FOV) angle in degrees.

Declaration

public void setCameraFov(float value)

Parameters

Name	Type	Description
value	float	The camera field of view (FOV) angle in degrees.

setCameraLatitude(@Nullable Float value) Method

Sets the camera latitude angle in degrees.

Declaration

public void setCameraLatitude(@Nullable Float value)

Parameters

Name	Type	Description
value		The camera latitude angle in degrees.

setCameraLongitude(@Nullable Float value) Method

Sets the camera longitude angle in degrees.

Declaration

public void setCameraLongitude(@Nullable Float value)

Parameters

Name	Type	Description
value		The camera longitude angle in degrees.

setCameraPreset(PresetCameraType value) Method

Sets the preset camera type.

Declaration

public void setCameraPreset(PresetCameraType value)

Parameters

Name	Type	Description
value	PresetCameraType	The preset camera type.

setCameraRevolution(@Nullable Float value) Method

Sets the camera revolution angle in degrees.

Declaration

public void setCameraRevolution(@Nullable Float value)

Parameters

Name	Type	Description
value		The camera revolution angle in degrees.

setCameraZoom(float value) Method

Sets the camera zoom value.

Declaration

public void setCameraZoom(float value)

Parameters

Name	Type	Description
value	float	The camera zoom value.

setContourColor(OfficeColor value) Method

Sets the shape contour color.

Declaration

public void setContourColor(OfficeColor value)

Parameters

Name	Type	Description
value	OfficeColor	The shape contour color.

setContourWidth(float value) Method

Sets the shape contour width.

Declaration

public void setContourWidth(float value)

Parameters

Name	Type	Description
value	float	The shape contour width.

setExtrusionColor(OfficeColor value) Method

Sets the extrusion color applied to a shape. Extrusion adds artificial height to the shape’s geometry.

Declaration

public void setExtrusionColor(OfficeColor value)

Parameters

Name	Type	Description
value	OfficeColor	The color of the extrusion applied to a shape.

setExtrusionHeight(float value) Method

Sets the extrusion height applied to a shape. Extrusion adds artificial height to the shape’s geometry.

Declaration

public void setExtrusionHeight(float value)

Parameters

Name	Type	Description
value	float	The height of the extrusion applied to a shape.

setLightRigDirection(LightRigDirection value) Method

Sets the light rig direction.

Declaration

public void setLightRigDirection(LightRigDirection value)

Parameters

Name	Type	Description
value	LightRigDirection	The light rig direction.

setLightRigLatitude(@Nullable Float value) Method

Sets the light rig latitude angle in degrees.

Declaration

public void setLightRigLatitude(@Nullable Float value)

Parameters

Name	Type	Description
value		The light rig latitude angle in degrees.

setLightRigLongitude(@Nullable Float value) Method

Sets the light rig longitude angle in degrees.

Declaration

public void setLightRigLongitude(@Nullable Float value)

Parameters

Name	Type	Description
value		The light rig longitude angle in degrees.

setLightRigPreset(LightRigPreset value) Method

Sets the light rig preset.

Declaration

public void setLightRigPreset(LightRigPreset value)

Parameters

Name	Type	Description
value	LightRigPreset	The light rig preset.

setLightRigRevolution(@Nullable Float value) Method

Sets the light rig revolution angle in degrees.

Declaration

public void setLightRigRevolution(@Nullable Float value)

Parameters

Name	Type	Description
value		The light rig revolution angle in degrees.

setPresetMaterial(PresetMaterialType value) Method

Sets the preset material applied to the shape.

Declaration

public void setPresetMaterial(PresetMaterialType value)

Parameters

Name	Type	Description
value	PresetMaterialType	The preset material applied to the shape.

setShapeDepth(float value) Method

Sets the shape depth.

Declaration

public void setShapeDepth(float value)

Parameters

Name	Type	Description
value	float	The shape depth.

setTopBevelHeight(float value) Method

Sets the height of the top bevel.

Declaration

public void setTopBevelHeight(float value)

Parameters

Name	Type	Description
value	float	The height of the top bevel.

setTopBevelPreset(PresetBevelType value) Method

Sets the top bevel preset.

Declaration

public void setTopBevelPreset(PresetBevelType value)

Parameters

Name	Type	Description
value	PresetBevelType	The top bevel preset.

setTopBevelWidth(float value) Method

Sets the width of the top bevel.

Declaration

public void setTopBevelWidth(float value)

Parameters

Name	Type	Description
value	float	The width of the top bevel.