Namespace EasyXLS.Drawings.Formatting

Class Rotation3D

System.Object

EasyXLS.Drawings.Formatting.Rotation3D

public class Rotation3D
extends System.Object

This class stores the 3D-rotation for drawing objects. It allows to set the X, Y, Z axis rotation and object position.

Constant Summary

Fields

Modifier and Type	Field	Description
const System.String	NO_ROTATION	A constant indicating that no rotation is set.
const System.String	OBLIQUE_BOTTOM_LEFT	A constant indicating the oblique bottom left rotation.
const System.String	OBLIQUE_BOTTOM_RIGHT	A constant indicating the oblique bottom right rotation.
const System.String	OBLIQUE_TOP_LEFT	A constant indicating the oblique top left rotation.
const System.String	OBLIQUE_TOP_RIGHT	A constant indicating the oblique top right rotation.
const System.String	ORTHOGRAPHIC_FRONT	A constant indicating the orthographic front rotation.
const System.String	PARALLEL_ISOMETRIC_BOTTOM_DOWN	A constant indicating the isometric top up rotation.
const System.String	PARALLEL_ISOMETRIC_LEFT_DOWN	A constant indicating the isometric left down rotation.
const System.String	PARALLEL_ISOMETRIC_OFF_AXIS_1_LEFT	A constant indicating the isometric off axis 1 left rotation.
const System.String	PARALLEL_ISOMETRIC_OFF_AXIS_1_RIGHT	A constant indicating the isometric off axis 1 right rotation.
const System.String	PARALLEL_ISOMETRIC_OFF_AXIS_1_TOP	A constant indicating the isometric off axis 1 top rotation.
const System.String	PARALLEL_ISOMETRIC_OFF_AXIS_2_LEFT	A constant indicating the isometric off axis 2 left rotation.
const System.String	PARALLEL_ISOMETRIC_OFF_AXIS_2_RIGHT	A constant indicating the isometric off axis 2 right rotation.
const System.String	PARALLEL_ISOMETRIC_OFF_AXIS_2_TOP	A constant indicating the isometric off axis 2 top rotation.
const System.String	PARALLEL_ISOMETRIC_RIGHT_UP	A constant indicating the isometric right up rotation.
const System.String	PARALLEL_ISOMETRIC_TOP_UP	A constant indicating the isometric top up rotation.
const System.String	PERSPECTIVE_ABOVE	A constant indicating the perspective above rotation.
const System.String	PERSPECTIVE_BELOW	A constant indicating the perspective below rotation.
const System.String	PERSPECTIVE_CONTRASTING_HEROIC_EXTREME_LEFT	A constant indicating the perspective heroic extreme left rotation.
const System.String	PERSPECTIVE_CONTRASTING_HEROIC_EXTREME_RIGHT	A constant indicating the perspective heroic extreme right rotation.
const System.String	PERSPECTIVE_CONTRASTING_LEFT	A constant indicating the perspective contrasting left rotation.
const System.String	PERSPECTIVE_CONTRASTING_RIGHT	A constant indicating the perspective contrasting right rotation.
const System.String	PERSPECTIVE_FRONT	A constant indicating the perspective front rotation.
const System.String	PERSPECTIVE_LEFT	A constant indicating the perspective left rotation.
const System.String	PERSPECTIVE_RELAXED	A constant indicating the perspective relaxed rotation.
const System.String	PERSPECTIVE_RELAXED_MODERATELY	A constant indicating the perspective relaxed moderately rotation.
const System.String	PERSPECTIVE_RIGHT	A constant indicating the perspective right rotation.

Constructor Summary

Constructors

Constructor	Description
Rotation3D()	Defines an instance of the 3D formatting.

Method Summary

Modifier and Type	Method	Description
Rotation3D	Clone()	Creates and returns a copy of this object.
float	getPerspective()	Returns the perspective of the camera.
System.String	getRotation()	Returns the rotation type of the shape.
float	getXAxisRotation()	Returns the rotation of the X axis.
float	getYAxisRotation()	Returns the rotation of the Y axis.
float	getZAxisRotation()	Returns the rotation of the Z axis.
bool	HasRotation()	Returns true if the shape is rotated, false otherwise.
void	setPerspective(float perspective)	Sets the perspective of the camera.
void	setRotation(System.String presetRotation)	Sets the rotation of the shape.
void	setXAxisRotation(float axisRotation)	Sets the rotation of the X axis.
void	setYAxisRotation(float axisRotation)	Sets the rotation of the Y axis.
void	setZAxisRotation(float axisRotation)	Sets the rotation of the Z axis.

Methods inherited from class System.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NO_ROTATION

public const final System.String NO_ROTATION

A constant indicating that no rotation is set. Embedded value is "none".

See Also:

Constant Values

PARALLEL_ISOMETRIC_LEFT_DOWN

public const final System.String PARALLEL_ISOMETRIC_LEFT_DOWN

A constant indicating the isometric left down rotation. Embedded value is "isometricLeftDown".

See Also:

Constant Values

PARALLEL_ISOMETRIC_RIGHT_UP

public const final System.String PARALLEL_ISOMETRIC_RIGHT_UP

A constant indicating the isometric right up rotation. Embedded value is "isometricRightUp".

See Also:

Constant Values

PARALLEL_ISOMETRIC_TOP_UP

public const final System.String PARALLEL_ISOMETRIC_TOP_UP

A constant indicating the isometric top up rotation. Embedded value is "isometricTopUp".

See Also:

Constant Values

PARALLEL_ISOMETRIC_BOTTOM_DOWN

public const final System.String PARALLEL_ISOMETRIC_BOTTOM_DOWN

A constant indicating the isometric top up rotation. Embedded value is "isometricBottomDown".

See Also:

Constant Values

PARALLEL_ISOMETRIC_OFF_AXIS_1_LEFT

public const final System.String PARALLEL_ISOMETRIC_OFF_AXIS_1_LEFT

A constant indicating the isometric off axis 1 left rotation. Embedded value is "isometricOffAxis1Left".

See Also:

Constant Values

PARALLEL_ISOMETRIC_OFF_AXIS_1_RIGHT

public const final System.String PARALLEL_ISOMETRIC_OFF_AXIS_1_RIGHT

A constant indicating the isometric off axis 1 right rotation. Embedded value is "isometricOffAxis1Right".

See Also:

Constant Values

PARALLEL_ISOMETRIC_OFF_AXIS_1_TOP

public const final System.String PARALLEL_ISOMETRIC_OFF_AXIS_1_TOP

A constant indicating the isometric off axis 1 top rotation. Embedded value is "isometricOffAxis1Top".

See Also:

Constant Values

PARALLEL_ISOMETRIC_OFF_AXIS_2_LEFT

public const final System.String PARALLEL_ISOMETRIC_OFF_AXIS_2_LEFT

A constant indicating the isometric off axis 2 left rotation. Embedded value is "isometricOffAxis2Left".

See Also:

Constant Values

PARALLEL_ISOMETRIC_OFF_AXIS_2_RIGHT

public const final System.String PARALLEL_ISOMETRIC_OFF_AXIS_2_RIGHT

A constant indicating the isometric off axis 2 right rotation. Embedded value is "isometricOffAxis2Right".

See Also:

Constant Values

PARALLEL_ISOMETRIC_OFF_AXIS_2_TOP

public const final System.String PARALLEL_ISOMETRIC_OFF_AXIS_2_TOP

A constant indicating the isometric off axis 2 top rotation. Embedded value is "isometricOffAxis2Top".

See Also:

Constant Values

PERSPECTIVE_FRONT

public const final System.String PERSPECTIVE_FRONT

A constant indicating the perspective front rotation. Embedded value is "perspectiveFront".

See Also:

Constant Values

PERSPECTIVE_LEFT

public const final System.String PERSPECTIVE_LEFT

A constant indicating the perspective left rotation. Embedded value is "perspectiveLeft".

See Also:

Constant Values

PERSPECTIVE_RIGHT

public const final System.String PERSPECTIVE_RIGHT

A constant indicating the perspective right rotation. Embedded value is "perspectiveRight".

See Also:

Constant Values

PERSPECTIVE_BELOW

public const final System.String PERSPECTIVE_BELOW

A constant indicating the perspective below rotation. Embedded value is "perspectiveBelow".

See Also:

Constant Values

PERSPECTIVE_ABOVE

public const final System.String PERSPECTIVE_ABOVE

A constant indicating the perspective above rotation. Embedded value is "perspectiveAbove".

See Also:

Constant Values

PERSPECTIVE_RELAXED_MODERATELY

public const final System.String PERSPECTIVE_RELAXED_MODERATELY

A constant indicating the perspective relaxed moderately rotation. Embedded value is "perspectiveRelaxedModerately".

See Also:

Constant Values

PERSPECTIVE_RELAXED

public const final System.String PERSPECTIVE_RELAXED

A constant indicating the perspective relaxed rotation. Embedded value is "perspectiveRelaxed".

See Also:

Constant Values

PERSPECTIVE_CONTRASTING_LEFT

public const final System.String PERSPECTIVE_CONTRASTING_LEFT

A constant indicating the perspective contrasting left rotation. Embedded value is "perspectiveContrastingLeftFacing".

See Also:

Constant Values

PERSPECTIVE_CONTRASTING_RIGHT

public const final System.String PERSPECTIVE_CONTRASTING_RIGHT

A constant indicating the perspective contrasting right rotation. Embedded value is "perspectiveContrastingRightFacing".

See Also:

Constant Values

PERSPECTIVE_CONTRASTING_HEROIC_EXTREME_LEFT

public const final System.String PERSPECTIVE_CONTRASTING_HEROIC_EXTREME_LEFT

A constant indicating the perspective heroic extreme left rotation. Embedded value is "perspectiveHeroicExtremeLeftFacing".

See Also:

Constant Values

PERSPECTIVE_CONTRASTING_HEROIC_EXTREME_RIGHT

public const final System.String PERSPECTIVE_CONTRASTING_HEROIC_EXTREME_RIGHT

A constant indicating the perspective heroic extreme right rotation. Embedded value is "perspectiveHeroicExtremeRightFacing".

See Also:

Constant Values

OBLIQUE_TOP_LEFT

public const final System.String OBLIQUE_TOP_LEFT

A constant indicating the oblique top left rotation. Embedded value is "obliqueTopLeft".

See Also:

Constant Values

OBLIQUE_TOP_RIGHT

public const final System.String OBLIQUE_TOP_RIGHT

A constant indicating the oblique top right rotation. Embedded value is "obliqueTopRight".

See Also:

Constant Values

OBLIQUE_BOTTOM_LEFT

public const final System.String OBLIQUE_BOTTOM_LEFT

A constant indicating the oblique bottom left rotation. Embedded value is "obliqueBottomLeft".

See Also:

Constant Values

OBLIQUE_BOTTOM_RIGHT

public const final System.String OBLIQUE_BOTTOM_RIGHT

A constant indicating the oblique bottom right rotation. Embedded value is "obliqueBottomRight".

See Also:

Constant Values

ORTHOGRAPHIC_FRONT

public const final System.String ORTHOGRAPHIC_FRONT

A constant indicating the orthographic front rotation. Embedded value is "orthographicFront".

See Also:

Constant Values

Constructor Details

Rotation3D

public Rotation3D()

Defines an instance of the 3D formatting.

Method Details

getRotation

public System.String getRotation()

Returns the rotation type of the shape. Possible values are available in Rotation3D class.

Returns:

the rotation type of the shape

See Also:

setRotation(System.String)

HasRotation

public bool HasRotation()

Returns true if the shape is rotated, false otherwise.

Returns:

true if the shape is rotated, false otherwise

See Also:

setRotation(System.String)

setRotation

public void setRotation(System.String presetRotation)

Sets the rotation of the shape.

Parameters:

presetRotation - the rotation of the shape. Possible values are available in Rotation3D class.

See Also:

getRotation()

getXAxisRotation

public float getXAxisRotation()

Returns the rotation of the X axis.

Returns:

the rotation of the X axis

See Also:

getYAxisRotation(), getZAxisRotation(), getPerspective(), setXAxisRotation(float), setYAxisRotation(float), setZAxisRotation(float), setPerspective(float)

setXAxisRotation

public void setXAxisRotation(float axisRotation)

Sets the rotation of the X axis.

Parameters:

axisRotation - the rotation of the X axis.

See Also:

setYAxisRotation(float), setZAxisRotation(float), setPerspective(float), getXAxisRotation(), getYAxisRotation(), getZAxisRotation(), getPerspective()

getYAxisRotation

public float getYAxisRotation()

Returns the rotation of the Y axis.

Returns:

the rotation of the Y axis

See Also:

getXAxisRotation(), getZAxisRotation(), getPerspective(), setXAxisRotation(float), setYAxisRotation(float), setZAxisRotation(float), setPerspective(float)

setYAxisRotation

public void setYAxisRotation(float axisRotation)

Sets the rotation of the Y axis.

Parameters:

axisRotation - the rotation of the Y axis.

See Also:

setXAxisRotation(float), setZAxisRotation(float), setPerspective(float), getXAxisRotation(), getYAxisRotation(), getZAxisRotation(), getPerspective()

getZAxisRotation

public float getZAxisRotation()

Returns the rotation of the Z axis.

Returns:

the rotation of the Z axis

See Also:

getXAxisRotation(), getYAxisRotation(), getPerspective(), setXAxisRotation(float), setYAxisRotation(float), setZAxisRotation(float), setPerspective(float)

setZAxisRotation

public void setZAxisRotation(float axisRotation)

Sets the rotation of the Z axis.

Parameters:

axisRotation - the rotation of the Z axis.

See Also:

setXAxisRotation(float), setYAxisRotation(float), setPerspective(float), getXAxisRotation(), getYAxisRotation(), getZAxisRotation(), getPerspective()

getPerspective

public float getPerspective()

Returns the perspective of the camera.

Returns:

the perspective of the camera

See Also:

setPerspective(float), getXAxisRotation(), getYAxisRotation(), getZAxisRotation(), setXAxisRotation(float), setYAxisRotation(float), setZAxisRotation(float)

setPerspective

public void setPerspective(float perspective)

Sets the perspective of the camera.

Parameters:

perspective - the perspective of the camera

See Also:

getPerspective(), setXAxisRotation(float), setYAxisRotation(float), setZAxisRotation(float), getXAxisRotation(), getYAxisRotation(), getZAxisRotation()

Clone

public Rotation3D Clone()

Creates and returns a copy of this object.

Returns:

a clone of this instance.