com.xj.anylogic.engine.presentation
Class Shape3DRectangle

java.lang.Object
  com.xj.anylogic.engine.presentation.Shape
      com.xj.anylogic.engine.presentation.ShapeLineFill
          com.xj.anylogic.engine.presentation.ShapeRectangle
              com.xj.anylogic.engine.presentation.Shape3DRectangle

All Implemented Interfaces:

Area2D, Area3D, com.xj.anylogic.engine.internal.Child, com.xj.anylogic.engine.internal.presentation.Accessor3D_xjal, com.xj.anylogic.engine.internal.presentation.WorldObject3D_xjal, Locatable2D, Locatable3D, java.io.Serializable, java.lang.Cloneable

public class Shape3DRectangle
extends ShapeRectangle
implements Area3D, com.xj.anylogic.engine.internal.presentation.WorldObject3D_xjal

Persistent 3D rectangle shape. Also visible on 2D animation.
3D surface is actually an extrusion of an ordinary Rectangle (lying in the horizontal plane, with top-left corner at (x, y, z)) shape by Z-Height amount along +Z axis.

Author:

XJ Technologies Company Ltd. www.anylogic.com

See Also:

Serialized Form

Field Summary

Fields inherited from class com.xj.anylogic.engine.presentation.Shape

UNKNOWN_NAME

Constructor Summary

Shape3DRectangle()
Constructs a 3D rectangle with default attributes.

Shape3DRectangle(boolean ispublic, double x, double y, double z, double rotation, java.lang.Object lineColor, java.lang.Object fillColor, double width, double height, double zHeight, double lineWidth, int lineStyle)
Constructs a 3D rectangle with specific attributes.

Method Summary

Shape3DRectangle	clone() Creates and returns a copy of this shape (i.e. new shape instance).
Element3D_xjal	get3DElement_xjal() This method is internal and shouldn't be accessed by user.
Presentable	getPresentable() Returns the Presentable object (ActiveObject or Experiment) where this shape belongs to, or null.
double	getScaleZ() Returns the scale of the shape along z axis
double	getZ() Returns the z coordinate of the shape.
double	getZHeight() Returns the height of the rectangle along Z-axis
double	getZOffset() Returns the offset from z coordinate of the location base.
void	set3DElement_xjal(Element3D_xjal element3D) This method is internal and shouldn't be accessed by user.
void	setContextReference_xjal(Presentable contextReference) This method is internal and shouldn't be accessed by user.
void	setFillColor(java.lang.Object fillColor) Sets the fill color (or Texture) of the shape.
void	setHeight(double height) Sets the height of the rectangle.
void	setLineColor(java.lang.Object lineColor) Sets the line color (or Texture) of the shape.
void	setLineStyle(int style) Does nothing: the only supported in 3D line style is solid
void	setLineWidth(double width) Sets the line width of the shape, 0 means thinnest possible
void	setPos(double x, double y) Sets (x, y) coordinates of the shape.
void	setPos(double x, double y, double z) Sets coordinates of the shape
void	setRotation(double rotation) Sets the rotation of the shape.
void	setScale(double scale) Sets the scale of the figure along all the axes
void	setScale(double sx, double sy) Sets the scales of the shape along both axes
void	setScaleX(double sx) Sets the scale of the shape along x axis
void	setScaleY(double sy) Sets the scale of the shape along y axis
void	setScaleZ(double sz) Sets the scale of the shape along z axis
void	setSize(double width, double height) Sets the width and height of the rectangle.
void	setVisible(boolean visible) Sets the visibility of the shape.
void	setWidth(double width) Sets the width of the rectangle.
void	setX(double x) Sets the x coordinate of the shape
void	setY(double y) Sets the y coordinate of the shape
void	setZ(double z) Sets the z coordinate of the figure
void	setZHeight(double zHeight) Sets the height of the rectangle along Z-axis

Methods inherited from class com.xj.anylogic.engine.presentation.ShapeRectangle

contains, draw, getHeight, getWidth, onClickAt

Methods inherited from class com.xj.anylogic.engine.presentation.ShapeLineFill

getFillColor, getFillTexture, getLineColor, getLineStyle, getLineTexture, getLineWidth, setFillColor, setLineColor

Methods inherited from class com.xj.anylogic.engine.presentation.Shape

canHandleClick, getGroup, getName, getRotation, getScaleX, getScaleY, getX, getY, isVisible, onClick, restoreOwner

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xj.anylogic.engine.Area2D

getHeight, getWidth, getX, getY

Constructor Detail

Shape3DRectangle

public Shape3DRectangle()

Constructs a 3D rectangle with default attributes.

Shape3DRectangle

public Shape3DRectangle(boolean ispublic,
                        double x,
                        double y,
                        double z,
                        double rotation,
                        java.lang.Object lineColor,
                        java.lang.Object fillColor,
                        double width,
                        double height,
                        double zHeight,
                        double lineWidth,
                        int lineStyle)

Constructs a 3D rectangle with specific attributes.

Parameters:

ispublic - if true, the shape is visible on container's presentation

x - the x coordinate of the rectangle upper left corner on the XY-projection

y - the y coordinate of the rectangle upper left corner on the XY-projection

z - the z coordinate of the rectangle base

rotation - the rotation of the rectangle around Z-axis from +X to +Y, in radians

lineColor - line color (or Texture) of the rectangle

fillColor - fill color (or Texture) of the rectangle

width - the width of the rectangle on the XY-projection

height - the height of the rectangle on the XY-projection

zHeight - the height of a rectangle along Z-axis

lineWidth - the line width of the rectangle

lineStyle - the line stroke style of the rectangle (only solid is supported)

Method Detail

clone

public Shape3DRectangle clone()

Description copied from class: Shape

Creates and returns a copy of this shape (i.e. new shape instance).
The returned shape is the object of the same class
The returned copy isn't automatically added to the group this shape belongs to.
The clone is created in the context of the same experiment or active object

Note that cloning of GIS shape, controls and charts is not supported

Overrides:

clone in class ShapeRectangle

setX

public void setX(double x)

Description copied from class: Shape

Sets the x coordinate of the shape

Overrides:

setX in class Shape

Parameters:

x - the new value of x coordinate

setY

public void setY(double y)

Description copied from class: Shape

Sets the y coordinate of the shape

Overrides:

setY in class Shape

Parameters:

y - the new value of y coordinate

setZ

public void setZ(double z)

Sets the z coordinate of the figure

Parameters:

z - the new value of z coordinate

getZ

public double getZ()

Returns the z coordinate of the shape.

Specified by:

getZ in interface Area3D

Specified by:

getZ in interface Locatable3D

Returns:

the z coordinate of the shape

getZOffset

public double getZOffset()

Description copied from interface: Locatable3D

Returns the offset from z coordinate of the location base.
This e.g. returns getZHeight() for some 3D shapes

Specified by:

getZOffset in interface Locatable3D

Returns:

the offset from z coordinate of the location

setZHeight

public void setZHeight(double zHeight)

Sets the height of the rectangle along Z-axis

Parameters:

zHeight - the new value of z-height

getZHeight

public double getZHeight()

Returns the height of the rectangle along Z-axis

Specified by:

getZHeight in interface Area3D

Returns:

the height of the rectangle along Z-axis

setWidth

public void setWidth(double width)

Description copied from class: ShapeRectangle

Sets the width of the rectangle.

Overrides:

setWidth in class ShapeRectangle

Parameters:

width - the new width of the rectangle

setHeight

public void setHeight(double height)

Description copied from class: ShapeRectangle

Sets the height of the rectangle.

Overrides:

setHeight in class ShapeRectangle

Parameters:

height - the new height of the rectangle

setSize

public void setSize(double width,
                    double height)

Description copied from class: ShapeRectangle

Sets the width and height of the rectangle.

Overrides:

setSize in class ShapeRectangle

Parameters:

width - the new width of the rectangle

height - the new height of the rectangle

setLineWidth

public void setLineWidth(double width)

Description copied from class: ShapeLineFill

Sets the line width of the shape, 0 means thinnest possible

Overrides:

setLineWidth in class ShapeLineFill

Parameters:

width - the new line width of the shape

setLineStyle

public void setLineStyle(int style)

Does nothing: the only supported in 3D line style is solid

Overrides:

setLineStyle in class ShapeLineFill

Parameters:

style - the new style of the shape

setLineColor

public void setLineColor(java.lang.Object lineColor)

Description copied from class: ShapeLineFill

Sets the line color (or Texture) of the shape.

Overrides:

setLineColor in class ShapeLineFill

Parameters:

lineColor - the new line color, null = do not draw the shape line

setFillColor

public void setFillColor(java.lang.Object fillColor)

Description copied from class: ShapeLineFill

Sets the fill color (or Texture) of the shape.

Overrides:

setFillColor in class ShapeLineFill

Parameters:

fillColor - the new fill color, null = do not fill the shape

setPos

public void setPos(double x,
                   double y)

Sets (x, y) coordinates of the shape.
Z-coordinate is left unchanged

Overrides:

setPos in class Shape

Parameters:

x - the new value of x coordinate

y - the new value of y coordinate

setPos

public void setPos(double x,
                   double y,
                   double z)

Sets coordinates of the shape

Parameters:

x - the new value of x coordinate

y - the new value of y coordinate

z - the new value of z coordinate

setScale

public void setScale(double scale)

Sets the scale of the figure along all the axes

Overrides:

setScale in class Shape

Parameters:

scale - the new value of scale

setScale

public void setScale(double sx,
                     double sy)

Description copied from class: Shape

Sets the scales of the shape along both axes

Overrides:

setScale in class Shape

Parameters:

sx - the new value of scale along x axis, 1 = keep original size

sy - the new value of scale along y axis, 1 = keep original size

setScaleX

public void setScaleX(double sx)

Description copied from class: Shape

Sets the scale of the shape along x axis

Overrides:

setScaleX in class Shape

Parameters:

sx - the new value of scale along x axis, 1 = keep original size

setScaleY

public void setScaleY(double sy)

Description copied from class: Shape

Sets the scale of the shape along y axis

Overrides:

setScaleY in class Shape

Parameters:

sy - the new value of scale along y axis, 1 = keep original size

setScaleZ

public void setScaleZ(double sz)

Sets the scale of the shape along z axis

Parameters:

sz - the new value of scale along z axis, 1 = keep original size

getScaleZ

public double getScaleZ()

Returns the scale of the shape along z axis

Returns:

the scale of the shape along z axis, 1 = keep original size

setRotation

public void setRotation(double rotation)

Description copied from class: Shape

Sets the rotation of the shape.

Overrides:

setRotation in class Shape

Parameters:

rotation - the new value of rotation in radians

setVisible

public void setVisible(boolean visible)

Description copied from class: Shape

Sets the visibility of the shape.

Overrides:

setVisible in class Shape

Parameters:

visible - visibility: true - visible, false - not

getPresentable

public Presentable getPresentable()

Description copied from class: Shape

Returns the Presentable object (ActiveObject or Experiment) where this shape belongs to, or null.

Specified by:

getPresentable in interface com.xj.anylogic.engine.internal.presentation.WorldObject3D_xjal

Overrides:

getPresentable in class Shape

Returns:

the Presentable that owns this shape, or null

get3DElement_xjal

public Element3D_xjal get3DElement_xjal()

Description copied from interface: com.xj.anylogic.engine.internal.presentation.Accessor3D_xjal

This method is internal and shouldn't be accessed by user.
It is public due to technical reasons.

Specified by:

get3DElement_xjal in interface com.xj.anylogic.engine.internal.presentation.Accessor3D_xjal

set3DElement_xjal

public void set3DElement_xjal(Element3D_xjal element3D)

Description copied from interface: com.xj.anylogic.engine.internal.presentation.Accessor3D_xjal

This method is internal and shouldn't be accessed by user.
It is public due to technical reasons.

Specified by:

set3DElement_xjal in interface com.xj.anylogic.engine.internal.presentation.Accessor3D_xjal

setContextReference_xjal

public void setContextReference_xjal(Presentable contextReference)

Description copied from interface: com.xj.anylogic.engine.internal.presentation.WorldObject3D_xjal

This method is internal and shouldn't be accessed by user.
It is public due to technical reasons.

Specified by:

setContextReference_xjal in interface com.xj.anylogic.engine.internal.presentation.WorldObject3D_xjal