com.aspose.slides
Class ThreeDFormat

java.lang.Object
  extended by com.aspose.slides.ThreeDFormat

public final class ThreeDFormat
extends java.lang.Object

Represents the 3D format of a shape.


Method Summary
 float getAmbientLightIntensity()
          Returns the ambient light intensity.
 float getAngleX()
          Returns the rotation angle around X axis.
 float getAngleY()
          Returns the rotation angle around Y axis.
 float getDepth()
          Returns the depth of a shape in points (1/72 of inch).
 float getDiffuseAmount()
          Returns the amount of a diffuse lighting.
 float getDirectLightIntensity()
          Returns the intensity of a direct light.
 int getDirectLightSourceX()
          Returns the X coordinate of a direction-to-source vector of a direct light.
 int getDirectLightSourceY()
          Returns the Y coordinate of a direction-to-source vector of a direct light.
 int getDirectLightSourceZ()
          Returns the Z coordinate of a direction-to-source vector of a direct light.
 java.awt.Color getExtrusionColor()
          Returns the color of a side surface of a shape.
 short getExtrusionColorIndex()
          Returns the index of shadow's color in color scheme, -1 for scheme independed color or -2 if ExtrusionColor is not defined.
 int getExtrusionDirection()
          Returns the direction of a shape extrusion.
 int getLightingDirection()
          Returns the lighting direction.
 float getReflectedLightIntensity()
          Returns the intensity of a reflected light.
 int getReflectedLightSourceX()
          Returns the X coordinate of a direction-to-source vector of a reflected light.
 int getReflectedLightSourceY()
          Returns the Y coordinate of a direction-to-source vector of a reflected light.
 int getReflectedLightSourceZ()
          Returns the Z coordinate of a direction-to-source vector of a reflected light.
 short getSkewAmount()
          Returns the amount of a skew in percents of a shape's depth.
 float getSkewAngle()
          Returns the angle of a skew.
 int getThreeDRenderingType()
          Returns the 3D rendering type of a shape.
 int getThreeDStyle()
          Returns the 3D style of a shape.
 float getViewpointOffsetX()
          Returns the X offset of a viewpoint in points (1/72 of inch).
 float getViewpointOffsetY()
          Returns the Y offset of a viewpoint in points (1/72 of inch).
 float getViewpointOriginX()
          Returns the X coordinate of a viewpoint origin.
 float getViewpointOriginY()
          Returns the Y coordinate of a viewpoint origin.
 boolean isPerspectiveProjection()
          Determines whether the perspective projection is used.
 boolean isVisible()
          Determines whether the shape has 3D decoration.
 void setAmbientLightIntensity(float value)
          Sets the ambient light intensity.
 void setAngleX(float value)
          Sets the rotation angle around X axis.
 void setAngleY(float value)
          Sets the rotation angle around Y axis.
 void setDepth(float value)
          Sets the depth of a shape in points (1/72 of inch).
 void setDiffuseAmount(float value)
          Sets the amount of a diffuse lighting.
 void setDirectLightIntensity(float value)
          Sets the intensity of a direct light.
 void setDirectLightSourceX(int value)
          Sets the X coordinate of a direction-to-source vector of a direct light.
 void setDirectLightSourceY(int value)
          Sets the Y coordinate of a direction-to-source vector of a direct light.
 void setDirectLightSourceZ(int value)
          Sets the Z coordinate of a direction-to-source vector of a direct light.
 void setExtrusionColor(java.awt.Color value)
          Sets the color of a side surface of a shape.
 void setExtrusionColorIndex(short value)
          Sets the index of shadow's color in color scheme, -1 for scheme independed color or -2 if ExtrusionColor is not defined.
 void setExtrusionDirection(int value)
          Sets the direction of a shape extrusion.
 void setLightingDirection(int value)
          Sets the lighting direction.
 void setPerspectiveProjection(boolean value)
          Sets whether the perspective projection is used.
 void setReflectedLightIntensity(float value)
          Sets the intensity of a reflected light.
 void setReflectedLightSourceX(int value)
          Sets the X coordinate of a direction-to-source vector of a reflected light.
 void setReflectedLightSourceY(int value)
          Sets the Y coordinate of a direction-to-source vector of a reflected light.
 void setReflectedLightSourceZ(int value)
          Sets the Z coordinate of a direction-to-source vector of a reflected light.
 void setSkewAmount(short value)
          Sets the amount of a skew in percents of a shape's depth.
 void setSkewAngle(float value)
          Sets the angle of a skew.
 void setThreeDRenderingType(int value)
          Sets the 3D rendering type of a shape.
 void setThreeDStyle(int value)
          Sets the 3D style of a shape.
 void setViewpointOffsetX(float value)
          Sets the X offset of a viewpoint in points (1/72 of inch).
 void setViewpointOffsetY(float value)
          Sets the Y offset of a viewpoint in points (1/72 of inch).
 void setViewpointOriginX(float value)
          Sets the X coordinate of a viewpoint origin.
 void setViewpointOriginY(float value)
          Sets the Y coordinate of a viewpoint origin.
 void setVisible(boolean value)
          Sets whether the shape has 3D decoration.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

isVisible

public boolean isVisible()
Determines whether the shape has 3D decoration.

Returns:
true if the shape has 3D decoration.

setVisible

public void setVisible(boolean value)
Sets whether the shape has 3D decoration.

Parameters:
value - true if the shape has 3D decoration.

getThreeDStyle

public int getThreeDStyle()
Returns the 3D style of a shape.

Returns:
the 3D style of a shape. See ThreeDStyle.

setThreeDStyle

public void setThreeDStyle(int value)
Sets the 3D style of a shape.

Parameters:
value - the 3D style of a shape. See ThreeDStyle.

getThreeDRenderingType

public int getThreeDRenderingType()
Returns the 3D rendering type of a shape.

Returns:
the 3D rendering type of a shape. See ThreeDRenderingType.

setThreeDRenderingType

public void setThreeDRenderingType(int value)
Sets the 3D rendering type of a shape.

Parameters:
value - the 3D rendering type of a shape. See ThreeDRenderingType.

getExtrusionColor

public java.awt.Color getExtrusionColor()
Returns the color of a side surface of a shape.

Returns:
the color of a side surface of a shape.

setExtrusionColor

public void setExtrusionColor(java.awt.Color value)
Sets the color of a side surface of a shape.

Parameters:
value - the color of a side surface of a shape.

getExtrusionColorIndex

public short getExtrusionColorIndex()
Returns the index of shadow's color in color scheme,

-1 for scheme independed color or

-2 if ExtrusionColor is not defined.

Returns:
the index of shadow's color.

setExtrusionColorIndex

public void setExtrusionColorIndex(short value)
Sets the index of shadow's color in color scheme,

-1 for scheme independed color or

-2 if ExtrusionColor is not defined.

Parameters:
value - the index of shadow's color.

getDepth

public float getDepth()
Returns the depth of a shape in points (1/72 of inch).

Returns:
the depth of a shape in points (1/72 of inch).

setDepth

public void setDepth(float value)
Sets the depth of a shape in points (1/72 of inch).

Parameters:
value - the depth of a shape in points (1/72 of inch).

getAngleY

public float getAngleY()
Returns the rotation angle around Y axis.

Returns:
the rotation angle around Y axis.

setAngleY

public void setAngleY(float value)
Sets the rotation angle around Y axis.

Parameters:
value - the rotation angle around Y axis.

getAngleX

public float getAngleX()
Returns the rotation angle around X axis.

Returns:
the rotation angle around X axis.

setAngleX

public void setAngleX(float value)
Sets the rotation angle around X axis.

Parameters:
value - the rotation angle around X axis.

isPerspectiveProjection

public boolean isPerspectiveProjection()
Determines whether the perspective projection is used.

Returns:
true if perspective projection is used.

setPerspectiveProjection

public void setPerspectiveProjection(boolean value)
Sets whether the perspective projection is used.

Parameters:
value - true if perspective projection is used.

getExtrusionDirection

public int getExtrusionDirection()
Returns the direction of a shape extrusion. Extrusion direction determines which side surfaces of a 3D shape will be visible. See ExtrusionDirection.

Returns:
the direction of a shape extrusion.

setExtrusionDirection

public void setExtrusionDirection(int value)
Sets the direction of a shape extrusion. Extrusion direction determines which side surfaces of a 3D shape will be visible. See ExtrusionDirection.

Parameters:
value - the direction of a shape extrusion.

getSkewAngle

public float getSkewAngle()
Returns the angle of a skew. Used with parallel projection to make side surfaces of a shape visible. Value 0 means there is no skew, to make angle equal to zero use -360.

Note: This property is for advanced control only.

Returns:
the angle of a skew.

setSkewAngle

public void setSkewAngle(float value)
Sets the angle of a skew. Used with parallel projection to make side surfaces of a shape visible. Value 0 means there is no skew, to make angle equal to zero use -360.

Note: This property is for advanced control only.

Parameters:
value - the angle of a skew.

getSkewAmount

public short getSkewAmount()
Returns the amount of a skew in percents of a shape's depth. Used with parallel projection to make side surfaces of a shape visible.

Note: This property is for advanced control only.

Returns:
the amount of a skew in percents of a shape's depth.

setSkewAmount

public void setSkewAmount(short value)
Sets the amount of a skew in percents of a shape's depth. Used with parallel projection to make side surfaces of a shape visible.

Note: This property is for advanced control only.

Parameters:
value - the amount of a skew in percents of a shape's depth.

getViewpointOriginX

public float getViewpointOriginX()
Returns the X coordinate of a viewpoint origin. Viewpoint origin X is equal to Shape.X + ViewpointOriginX * Shape.Width. Viewpoint determines "vanishing point" - point in a perspective drawing to which parallel lines seem to converge. Used with perspective projection to make side surfaces of a shape visible.

Note: This property is for advanced control only.

Returns:
the X coordinate of a viewpoint origin.

setViewpointOriginX

public void setViewpointOriginX(float value)
Sets the X coordinate of a viewpoint origin. Viewpoint origin X is equal to Shape.X + ViewpointOriginX * Shape.Width. Viewpoint determines "vanishing point" - point in a perspective drawing to which parallel lines seem to converge. Used with perspective projection to make side surfaces of a shape visible.

Note: This property is for advanced control only.

Parameters:
value - the X coordinate of a viewpoint origin.

getViewpointOriginY

public float getViewpointOriginY()
Returns the Y coordinate of a viewpoint origin. Viewpoint origin Y is equal to Shape.Y + ViewpointOriginY * Shape.Height. Viewpoint determines "vanishing point" - point in a perspective drawing to which parallel lines seem to converge. Used with perspective projection to make side surfaces of a shape visible.

Note: This property is for advanced control only.

Returns:
the Y coordinate of a viewpoint origin.

setViewpointOriginY

public void setViewpointOriginY(float value)
Sets the Y coordinate of a viewpoint origin. Viewpoint origin Y is equal to Shape.Y + ViewpointOriginY * Shape.Height. Viewpoint determines "vanishing point" - point in a perspective drawing to which parallel lines seem to converge. Used with perspective projection to make side surfaces of a shape visible.

Note: This property is for advanced control only.

Parameters:
value - the Y coordinate of a viewpoint origin.

getViewpointOffsetX

public float getViewpointOffsetX()
Returns the X offset of a viewpoint in points (1/72 of inch). Viewpoint determines "vanishing point" - point in a perspective drawing to which parallel lines seem to converge. Used with perspective projection to make side surfaces of a shape visible.

Note: This property is for advanced control only.

Returns:
the X offset of a viewpoint in points (1/72 of inch).

setViewpointOffsetX

public void setViewpointOffsetX(float value)
Sets the X offset of a viewpoint in points (1/72 of inch). Viewpoint determines "vanishing point" - point in a perspective drawing to which parallel lines seem to converge. Used with perspective projection to make side surfaces of a shape visible.

Note: This property is for advanced control only.

Parameters:
value - the X offset of a viewpoint in points (1/72 of inch).

getViewpointOffsetY

public float getViewpointOffsetY()
Returns the Y offset of a viewpoint in points (1/72 of inch). Viewpoint determines "vanishing point" - point in a perspective drawing to which parallel lines seem to converge. Used with perspective projection to make side surfaces of a shape visible.

Note: This property is for advanced control only.

Returns:
the Y offset of a viewpoint in points (1/72 of inch).

setViewpointOffsetY

public void setViewpointOffsetY(float value)
Sets the Y offset of a viewpoint in points (1/72 of inch). Viewpoint determines "vanishing point" - point in a perspective drawing to which parallel lines seem to converge. Used with perspective projection to make side surfaces of a shape visible.

Note: This property is for advanced control only.

Parameters:
value - the Y offset of a viewpoint in points (1/72 of inch).

getDiffuseAmount

public float getDiffuseAmount()
Returns the amount of a diffuse lighting.

Returns:
the amount of a diffuse lighting.

setDiffuseAmount

public void setDiffuseAmount(float value)
Sets the amount of a diffuse lighting.

Parameters:
value - the amount of a diffuse lighting.

getLightingDirection

public int getLightingDirection()
Returns the lighting direction.

Returns:
the lighting direction. See LightingDirection.

setLightingDirection

public void setLightingDirection(int value)
Sets the lighting direction.

Parameters:
value - the lighting direction. See LightingDirection.

getAmbientLightIntensity

public float getAmbientLightIntensity()
Returns the ambient light intensity.

Returns:
the ambient light intensity.

setAmbientLightIntensity

public void setAmbientLightIntensity(float value)
Sets the ambient light intensity.

Parameters:
value - the ambient light intensity.

getDirectLightSourceX

public int getDirectLightSourceX()
Returns the X coordinate of a direction-to-source vector of a direct light.

Returns:
the X coordinate of a direction-to-source vector of a direct light.

setDirectLightSourceX

public void setDirectLightSourceX(int value)
Sets the X coordinate of a direction-to-source vector of a direct light.

Parameters:
value - the X coordinate of a direction-to-source vector of a direct light.

getDirectLightSourceY

public int getDirectLightSourceY()
Returns the Y coordinate of a direction-to-source vector of a direct light.

Returns:
the Y coordinate of a direction-to-source vector of a direct light.

setDirectLightSourceY

public void setDirectLightSourceY(int value)
Sets the Y coordinate of a direction-to-source vector of a direct light.

Parameters:
value - the Y coordinate of a direction-to-source vector of a direct light.

getDirectLightSourceZ

public int getDirectLightSourceZ()
Returns the Z coordinate of a direction-to-source vector of a direct light.

Returns:
the Z coordinate of a direction-to-source vector of a direct light.

setDirectLightSourceZ

public void setDirectLightSourceZ(int value)
Sets the Z coordinate of a direction-to-source vector of a direct light.

Parameters:
value - the Z coordinate of a direction-to-source vector of a direct light.

getDirectLightIntensity

public float getDirectLightIntensity()
Returns the intensity of a direct light.

Returns:
the intensity of a direct light.

setDirectLightIntensity

public void setDirectLightIntensity(float value)
Sets the intensity of a direct light.

Parameters:
value - the intensity of a direct light.

getReflectedLightSourceX

public int getReflectedLightSourceX()
Returns the X coordinate of a direction-to-source vector of a reflected light.

Returns:
the X coordinate of a direction-to-source vector of a reflected light.

setReflectedLightSourceX

public void setReflectedLightSourceX(int value)
Sets the X coordinate of a direction-to-source vector of a reflected light.

Parameters:
value - the X coordinate of a direction-to-source vector of a reflected light.

getReflectedLightSourceY

public int getReflectedLightSourceY()
Returns the Y coordinate of a direction-to-source vector of a reflected light.

Returns:
the Y coordinate of a direction-to-source vector of a reflected light.

setReflectedLightSourceY

public void setReflectedLightSourceY(int value)
Sets the Y coordinate of a direction-to-source vector of a reflected light.

Parameters:
value - the Y coordinate of a direction-to-source vector of a reflected light.

getReflectedLightSourceZ

public int getReflectedLightSourceZ()
Returns the Z coordinate of a direction-to-source vector of a reflected light.

Returns:
the Z coordinate of a direction-to-source vector of a reflected light.

setReflectedLightSourceZ

public void setReflectedLightSourceZ(int value)
Sets the Z coordinate of a direction-to-source vector of a reflected light.

Parameters:
value - the Z coordinate of a direction-to-source vector of a reflected light.

getReflectedLightIntensity

public float getReflectedLightIntensity()
Returns the intensity of a reflected light. Reflected light is used to emulate the first reflections of a light from surrounding objects. Contrary to a direct light, the reflected ligth has many sources, so it doesn't depend so much on light falling angle.

Returns:
the intensity of a reflected light.

setReflectedLightIntensity

public void setReflectedLightIntensity(float value)
Sets the intensity of a reflected light. Reflected light is used to emulate the first reflections of a light from surrounding objects. Contrary to a direct light, the reflected ligth has many sources, so it doesn't depend so much on light falling angle.

Parameters:
value - the intensity of a reflected light.