Namespace EasyXLS.Drawings.Formatting
Class Format3D
- System.Object
-
- EasyXLS.Drawings.Formatting.Format3D
-
public class Format3D extends System.Object
This class stores the 3D-formatting for drawing objects. It allows to set the top and bottom bevel appearance, the material and the lights.
-
-
Constant Summary
Fields Modifier and Type Field Description const System.String
BEVEL_ANGLE
A constant indicating the angle bevel.const System.String
BEVEL_ART_DECO
A constant indicating the art deco bevel.const System.String
BEVEL_CIRCLE
A constant indicating the circle bevel.const System.String
BEVEL_CONVEX
A constant indicating the convex bevel.const System.String
BEVEL_COOL_SLANT
A constant indicating the cool slant bevel.const System.String
BEVEL_CROSS
A constant indicating the cross bevel.const System.String
BEVEL_DIVOT
A constant indicating the divot bevel.const System.String
BEVEL_HARD_EDGE
A constant indicating the hard edge bevel.const System.String
BEVEL_NONE
A constant indicating that no bevel is set.const System.String
BEVEL_RELAXED_INSET
A constant indicating the relaxed inset bevel.const System.String
BEVEL_RIBLET
A constant indicating the riblet bevel.const System.String
BEVEL_SLOPE
A constant indicating the slope bevel.const System.String
BEVEL_SOFT_ROUND
A constant indicating the soft round bevel.const System.String
LIGHTING_BALANCE
A constant indicating the balanced lightning.const System.String
LIGHTING_BRIGHT_ROOM
A constant indicating the bright room lightning.const System.String
LIGHTING_CHILLY
A constant indicating the chilly lightning.const System.String
LIGHTING_CONTRASTING
A constant indicating the contrasting lightning.const System.String
LIGHTING_FLAT
A constant indicating the flat lightning.const System.String
LIGHTING_FLOOD
A constant indicating the flood lightning.const System.String
LIGHTING_FREEZING
A constant indicating the freezing lightning.const System.String
LIGHTING_GLOW
A constant indicating the glow lightning.const System.String
LIGHTING_HARSH
A constant indicating the harsh lightning.const System.String
LIGHTING_MORNING
A constant indicating the morning lightning.const System.String
LIGHTING_NONE
A constant indicating that no lights are set.const System.String
LIGHTING_SOFT
A constant indicating the soft lightning.const System.String
LIGHTING_SUNRISE
A constant indicating the sunrise lightning.const System.String
LIGHTING_SUNSET
A constant indicating the sunset lightning.const System.String
LIGHTING_THREE_POINT
A constant indicating the three point lightning.const System.String
LIGHTING_TWO_POINT
A constant indicating the two point lightning.const System.String
MATERIAL_CLEAR
A constant indicating the clear material.const System.String
MATERIAL_DARK_EDGE
A constant indicating the dark edge material.const System.String
MATERIAL_FLAT
A constant indicating the flat material.const System.String
MATERIAL_MATTE
A constant indicating the matte material.const System.String
MATERIAL_METAL
A constant indicating the metal material.const System.String
MATERIAL_NONE
A constant indicating that no material is set.const System.String
MATERIAL_PLASTIC
A constant indicating the plastic material.const System.String
MATERIAL_POWDER
A constant indicating the powder material.const System.String
MATERIAL_SOFT_EDGE
A constant indicating the soft edge material.const System.String
MATERIAL_TRANSLUCENT_POWDER
A constant indicating the translucent powder material.const System.String
MATERIAL_WARM_MATTE
A constant indicating the warm matte material.const System.String
MATERIAL_WIREFRAME
A constant indicating the wireframe material.
-
Constructor Summary
Constructors Constructor Description Format3D()
Defines an instance of the 3D formatting.
-
Method Summary
Modifier and Type Method Description Format3D
Clone()
Creates and returns a copy of this object.System.String
getBottomBevel()
Returns the type of the bottom bevel.float
getBottomBevelHeight()
Returns the height of the bottom bevel.float
getBottomBevelWidth()
Returns the width of the bottom bevel.float
getLightAngle()
Returns the angle of the lights.System.String
getLighting()
Returns the lighting of the shape.System.String
getMaterial()
Returns the material of the shape.System.String
getTopBevel()
Returns the type of the top bevel.float
getTopBevelHeight()
Returns the height of the top bevel.float
getTopBevelWidth()
Returns the width of the top bevel.void
setBottomBevel(System.String bevel)
Sets the type of the bottom bevel.void
setBottomBevelHeight(float height)
Sets the height of the bottom bevel.void
setBottomBevelWidth(float width)
Sets the width of the bottom bevel.void
setLightAngle(float angle)
Sets the angle of the lights.void
setLighting(System.String lighting)
Sets the lighting of the shape.void
setMaterial(System.String material)
Sets the material of the shape.void
setTopBevel(System.String bevel)
Sets the type of the top bevel.void
setTopBevelHeight(float height)
Sets the height of the top bevel.void
setTopBevelWidth(float width)
Sets the width of the top bevel.
-
-
-
Field Detail
-
BEVEL_NONE
public const System.String BEVEL_NONE
A constant indicating that no bevel is set. Embedded value is "none".- See Also:
- Constant Values
-
BEVEL_CIRCLE
public const System.String BEVEL_CIRCLE
A constant indicating the circle bevel. Embedded value is "circle".- See Also:
- Constant Values
-
BEVEL_RELAXED_INSET
public const System.String BEVEL_RELAXED_INSET
A constant indicating the relaxed inset bevel. Embedded value is "relaxedInset".- See Also:
- Constant Values
-
BEVEL_CROSS
public const System.String BEVEL_CROSS
A constant indicating the cross bevel. Embedded value is "cross".- See Also:
- Constant Values
-
BEVEL_COOL_SLANT
public const System.String BEVEL_COOL_SLANT
A constant indicating the cool slant bevel. Embedded value is "coolSlant".- See Also:
- Constant Values
-
BEVEL_ANGLE
public const System.String BEVEL_ANGLE
A constant indicating the angle bevel. Embedded value is "angle".- See Also:
- Constant Values
-
BEVEL_SOFT_ROUND
public const System.String BEVEL_SOFT_ROUND
A constant indicating the soft round bevel. Embedded value is "softRound".- See Also:
- Constant Values
-
BEVEL_CONVEX
public const System.String BEVEL_CONVEX
A constant indicating the convex bevel. Embedded value is "convex".- See Also:
- Constant Values
-
BEVEL_SLOPE
public const System.String BEVEL_SLOPE
A constant indicating the slope bevel. Embedded value is "slope".- See Also:
- Constant Values
-
BEVEL_DIVOT
public const System.String BEVEL_DIVOT
A constant indicating the divot bevel. Embedded value is "divot".- See Also:
- Constant Values
-
BEVEL_RIBLET
public const System.String BEVEL_RIBLET
A constant indicating the riblet bevel. Embedded value is "riblet".- See Also:
- Constant Values
-
BEVEL_HARD_EDGE
public const System.String BEVEL_HARD_EDGE
A constant indicating the hard edge bevel. Embedded value is "hardEdge".- See Also:
- Constant Values
-
BEVEL_ART_DECO
public const System.String BEVEL_ART_DECO
A constant indicating the art deco bevel. Embedded value is "artDeco".- See Also:
- Constant Values
-
MATERIAL_NONE
public const System.String MATERIAL_NONE
A constant indicating that no material is set. Embedded value is "none".- See Also:
- Constant Values
-
MATERIAL_MATTE
public const System.String MATERIAL_MATTE
A constant indicating the matte material. Embedded value is "matte".- See Also:
- Constant Values
-
MATERIAL_WARM_MATTE
public const System.String MATERIAL_WARM_MATTE
A constant indicating the warm matte material. Embedded value is "warmMatte".- See Also:
- Constant Values
-
MATERIAL_PLASTIC
public const System.String MATERIAL_PLASTIC
A constant indicating the plastic material. Embedded value is "plastic".- See Also:
- Constant Values
-
MATERIAL_METAL
public const System.String MATERIAL_METAL
A constant indicating the metal material. Embedded value is "metal".- See Also:
- Constant Values
-
MATERIAL_DARK_EDGE
public const System.String MATERIAL_DARK_EDGE
A constant indicating the dark edge material. Embedded value is "dkEdge".- See Also:
- Constant Values
-
MATERIAL_SOFT_EDGE
public const System.String MATERIAL_SOFT_EDGE
A constant indicating the soft edge material. Embedded value is "softEdge".- See Also:
- Constant Values
-
MATERIAL_FLAT
public const System.String MATERIAL_FLAT
A constant indicating the flat material. Embedded value is "flat".- See Also:
- Constant Values
-
MATERIAL_WIREFRAME
public const System.String MATERIAL_WIREFRAME
A constant indicating the wireframe material. Embedded value is "legacyWireframe".- See Also:
- Constant Values
-
MATERIAL_POWDER
public const System.String MATERIAL_POWDER
A constant indicating the powder material. Embedded value is "powder".- See Also:
- Constant Values
-
MATERIAL_TRANSLUCENT_POWDER
public const System.String MATERIAL_TRANSLUCENT_POWDER
A constant indicating the translucent powder material. Embedded value is "translucentPowder".- See Also:
- Constant Values
-
MATERIAL_CLEAR
public const System.String MATERIAL_CLEAR
A constant indicating the clear material. Embedded value is "clear".- See Also:
- Constant Values
-
LIGHTING_NONE
public const System.String LIGHTING_NONE
A constant indicating that no lights are set. Embedded value is "none".- See Also:
- Constant Values
-
LIGHTING_THREE_POINT
public const System.String LIGHTING_THREE_POINT
A constant indicating the three point lightning. Embedded value is "threePt".- See Also:
- Constant Values
-
LIGHTING_BALANCE
public const System.String LIGHTING_BALANCE
A constant indicating the balanced lightning. Embedded value is "balanced".- See Also:
- Constant Values
-
LIGHTING_SOFT
public const System.String LIGHTING_SOFT
A constant indicating the soft lightning. Embedded value is "soft".- See Also:
- Constant Values
-
LIGHTING_HARSH
public const System.String LIGHTING_HARSH
A constant indicating the harsh lightning. Embedded value is "harsh".- See Also:
- Constant Values
-
LIGHTING_FLOOD
public const System.String LIGHTING_FLOOD
A constant indicating the flood lightning. Embedded value is "flood".- See Also:
- Constant Values
-
LIGHTING_CONTRASTING
public const System.String LIGHTING_CONTRASTING
A constant indicating the contrasting lightning. Embedded value is "contrasting".- See Also:
- Constant Values
-
LIGHTING_MORNING
public const System.String LIGHTING_MORNING
A constant indicating the morning lightning. Embedded value is "morning".- See Also:
- Constant Values
-
LIGHTING_SUNRISE
public const System.String LIGHTING_SUNRISE
A constant indicating the sunrise lightning. Embedded value is "sunrise".- See Also:
- Constant Values
-
LIGHTING_SUNSET
public const System.String LIGHTING_SUNSET
A constant indicating the sunset lightning. Embedded value is "sunset".- See Also:
- Constant Values
-
LIGHTING_CHILLY
public const System.String LIGHTING_CHILLY
A constant indicating the chilly lightning. Embedded value is "chilly".- See Also:
- Constant Values
-
LIGHTING_FREEZING
public const System.String LIGHTING_FREEZING
A constant indicating the freezing lightning. Embedded value is "freezing".- See Also:
- Constant Values
-
LIGHTING_FLAT
public const System.String LIGHTING_FLAT
A constant indicating the flat lightning. Embedded value is "flat".- See Also:
- Constant Values
-
LIGHTING_TWO_POINT
public const System.String LIGHTING_TWO_POINT
A constant indicating the two point lightning. Embedded value is "twoPt".- See Also:
- Constant Values
-
LIGHTING_GLOW
public const System.String LIGHTING_GLOW
A constant indicating the glow lightning. Embedded value is "glow".- See Also:
- Constant Values
-
LIGHTING_BRIGHT_ROOM
public const System.String LIGHTING_BRIGHT_ROOM
A constant indicating the bright room lightning. Embedded value is "brightRoom".- See Also:
- Constant Values
-
-
Method Detail
-
getTopBevel
public System.String getTopBevel()
Returns the type of the top bevel. Possible values are available inFormat3D
class.- Returns:
- the type of the top bevel
- See Also:
setTopBevel(System.String)
,getTopBevelWidth()
,getTopBevelHeight()
,getBottomBevel()
-
setTopBevel
public void setTopBevel(System.String bevel)
Sets the type of the top bevel. Possible values are available inFormat3D
class.- Parameters:
bevel
- the type of the top bevel- See Also:
getTopBevel()
,setTopBevelWidth(float)
,setTopBevelHeight(float)
,setBottomBevel(System.String)
-
getTopBevelWidth
public float getTopBevelWidth()
Returns the width of the top bevel.- Returns:
- the width of the top bevel
- See Also:
setTopBevelWidth(float)
,getTopBevel()
,getTopBevelHeight()
,getBottomBevelWidth()
-
setTopBevelWidth
public void setTopBevelWidth(float width)
Sets the width of the top bevel.- Parameters:
width
- the width of the top bevel- See Also:
getTopBevelWidth()
,setTopBevel(System.String)
,setTopBevelHeight(float)
,setBottomBevelWidth(float)
-
getTopBevelHeight
public float getTopBevelHeight()
Returns the height of the top bevel.- Returns:
- the height of the top bevel
- See Also:
setTopBevelHeight(float)
,getTopBevel()
,getTopBevelWidth()
,getBottomBevelHeight()
-
setTopBevelHeight
public void setTopBevelHeight(float height)
Sets the height of the top bevel.- Parameters:
height
- the height of the top bevel- See Also:
getTopBevelHeight()
,setTopBevel(System.String)
,setTopBevelWidth(float)
,setBottomBevelHeight(float)
-
getBottomBevel
public System.String getBottomBevel()
Returns the type of the bottom bevel. Possible values are available inFormat3D
class.- Returns:
- the type of the bottom bevel
- See Also:
setBottomBevel(System.String)
,getBottomBevelWidth()
,getBottomBevelHeight()
,getTopBevel()
-
setBottomBevel
public void setBottomBevel(System.String bevel)
Sets the type of the bottom bevel. Possible values are available inFormat3D
class.- Parameters:
bevel
- the type of the bottom bevel- See Also:
getBottomBevel()
,setBottomBevelWidth(float)
,setBottomBevelHeight(float)
,setTopBevel(System.String)
-
getBottomBevelWidth
public float getBottomBevelWidth()
Returns the width of the bottom bevel.- Returns:
- the width of the bottom bevel
- See Also:
setBottomBevelWidth(float)
,getBottomBevel()
,getBottomBevelHeight()
,getTopBevelWidth()
-
setBottomBevelWidth
public void setBottomBevelWidth(float width)
Sets the width of the bottom bevel.- Parameters:
width
- the width of the bottom bevel- See Also:
getBottomBevelWidth()
,setBottomBevel(System.String)
,setBottomBevelHeight(float)
,setTopBevelWidth(float)
-
getBottomBevelHeight
public float getBottomBevelHeight()
Returns the height of the bottom bevel.- Returns:
- the height of the bottom bevel
- See Also:
setBottomBevelHeight(float)
,getBottomBevel()
,getBottomBevelWidth()
,getTopBevelHeight()
-
setBottomBevelHeight
public void setBottomBevelHeight(float height)
Sets the height of the bottom bevel.- Parameters:
height
- the height of the bottom bevel- See Also:
getBottomBevelHeight()
,setBottomBevel(System.String)
,setBottomBevelWidth(float)
,setTopBevelHeight(float)
-
getMaterial
public System.String getMaterial()
Returns the material of the shape.- Returns:
- the material of the shape
- See Also:
setMaterial(System.String)
,getLighting()
-
setMaterial
public void setMaterial(System.String material)
Sets the material of the shape.- Parameters:
material
- the material of the shape- See Also:
getMaterial()
,setLighting(System.String)
-
getLighting
public System.String getLighting()
Returns the lighting of the shape.- Returns:
- the lighting of the shape
- See Also:
setLighting(System.String)
,getMaterial()
-
setLighting
public void setLighting(System.String lighting)
Sets the lighting of the shape.- Parameters:
lighting
- the lighting of the shape- See Also:
getLighting()
,setMaterial(System.String)
-
getLightAngle
public float getLightAngle()
Returns the angle of the lights.- Returns:
- the angle of the lights
- See Also:
setLightAngle(float)
,getLighting()
,getMaterial()
-
setLightAngle
public void setLightAngle(float angle)
Sets the angle of the lights.- Parameters:
angle
- the angle of the lights- See Also:
getLightAngle()
,setLighting(System.String)
,setMaterial(System.String)
-
Clone
public Format3D Clone()
Creates and returns a copy of this object.- Returns:
- a clone of this instance.
-
-