com.xj.anylogic.engine.presentation
Class Shape3DArc

java.lang.Object
  com.xj.anylogic.engine.presentation.Shape
      com.xj.anylogic.engine.presentation.ShapeLineFill
          com.xj.anylogic.engine.presentation.ShapeOval
              com.xj.anylogic.engine.presentation.ShapeArc
                  com.xj.anylogic.engine.presentation.Shape3DArc

All Implemented Interfaces:

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 Shape3DArc
extends ShapeArc
implements Locatable3D, com.xj.anylogic.engine.internal.presentation.WorldObject3D_xjal

Persistent 3D arc shape. Also visible on 2D animation.
3D surface is actually an extrusion of an ordinary Arc shape (lying in the horizontal plane, with center at (x, y, z)) 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

Shape3DArc()
Constructs a 3D arc with default attributes.

Shape3DArc(boolean ispublic, double x, double y, double z, double rotation, java.lang.Object lineColor, java.lang.Object fillColor, double radiusX, double radiusY, double zHeight, double dz, double angleStart, double angle, double lineWidth, int lineStyle)
Constructs a 3D arc with specific attributes.

Shape3DArc(boolean ispublic, double x, double y, double z, double rotation, java.lang.Object lineColor, java.lang.Object fillColor, double radiusX, double radiusY, double zHeight, double angleStart, double angle, double lineWidth, int lineStyle)
Deprecated. This constructor is obsolete and will be removed in future releases. Please use constructor Shape3DArc(boolean, double, double, double, double, Object, Object, double, double, double, double, double, double, double, int)

Method Summary

Shape3DArc	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.
double	getDz() Returns the difference of z coordinates of the arc end and start points.
Presentable	getPresentable() Returns the Presentable object (ActiveObject or Experiment) where this shape belongs to, or null.
double	getRadiusX() Returns the radius of the arc along X-axis.
double	getRadiusY() Returns the radius of the arc along Y-axis.
double	getScaleZ() Returns the scale of the shape along z axis
double	getZ() Returns the z coordinate of the arc base.
double	getZHeight() Returns the height of the arc 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	setAngle(double angle) Sets the the angular extent of the arc in radians, clockwise.
void	setAngleStart(double angleStart) Sets the starting angle of the arc (0 means 3 o'clock) in radians, clockwise.
void	setContextReference_xjal(Presentable contextReference) This method is internal and shouldn't be accessed by user.
void	setDz(double dz) Sets the difference of z coordinates of the arc end and start points.
void	setFillColor(java.lang.Object fillColor) Sets the fill color (or Texture) of the shape.
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 base arc center
void	setRadius(double radius) Sets both radiuses of the oval to the same given value, i.e. makes it a circle.
void	setRadiusX(double radiusX) Sets the radius of the arc along X-axis.
void	setRadiusY(double radiusY) Sets the radius of the arc along Y-axis.
void	setRotation(double rotation) Sets the rotation of the shape.
void	setScale(double scale) Sets the scale of the shape 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	setVisible(boolean visible) Sets the visibility of the shape.
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 arc base
void	setZHeight(double zHeight) Sets the height of the arc along Z-axis

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

contains, draw, getAngle, getAngleStart, 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.Locatable2D

getX, getY

Constructor Detail

Shape3DArc

public Shape3DArc()

Constructs a 3D arc with default attributes.

Shape3DArc

@Deprecated
public Shape3DArc(boolean ispublic,
                             double x,
                             double y,
                             double z,
                             double rotation,
                             java.lang.Object lineColor,
                             java.lang.Object fillColor,
                             double radiusX,
                             double radiusY,
                             double zHeight,
                             double angleStart,
                             double angle,
                             double lineWidth,
                             int lineStyle)

Deprecated. This constructor is obsolete and will be removed in future releases. Please use constructor Shape3DArc(boolean, double, double, double, double, Object, Object, double, double, double, double, double, double, double, int)

Shape3DArc

public Shape3DArc(boolean ispublic,
                  double x,
                  double y,
                  double z,
                  double rotation,
                  java.lang.Object lineColor,
                  java.lang.Object fillColor,
                  double radiusX,
                  double radiusY,
                  double zHeight,
                  double dz,
                  double angleStart,
                  double angle,
                  double lineWidth,
                  int lineStyle)

Constructs a 3D arc with specific attributes.

Parameters:

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

x - the x coordinate of the arc center

y - the y coordinate of the arc center

z - the z coordinate of the arc center

rotation - the rotation of the arc in radians

lineColor - line color (or Texture) of the arc

fillColor - fill color (or Texture) of the arc

radiusX - the radius of the arc along X-axis

radiusY - the radius of the arc along Y-axis

zHeight - the height of the arc along Z-axis

dz - the difference of z coordinates of the arc end and start points

angleStart - the starting angle of the arc (0 means 3 o'clock) in radians, clockwise

angle - the angular extent of the arc in radians, clockwise

lineWidth - the line width of the arc

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

Method Detail

clone

public Shape3DArc 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 ShapeArc

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 arc base

Parameters:

z - the new value of z coordinate

getZ

public double getZ()

Returns the z coordinate of the arc base.

Specified by:

getZ in interface Locatable3D

Returns:

the z coordinate of the arc base

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 arc along Z-axis

Parameters:

zHeight - the new value of z-height

getZHeight

public double getZHeight()

Returns the height of the arc along Z-axis

Returns:

the height of the arc along Z-axis

setDz

public void setDz(double dz)

Sets the difference of z coordinates of the arc end and start points.

Parameters:

dz - the new difference of z coordinates of the arc end and start points

getDz

public double getDz()

Returns the difference of z coordinates of the arc end and start points.

Returns:

the difference of z coordinates of the arc end and start points

setRadiusX

public void setRadiusX(double radiusX)

Sets the radius of the arc along X-axis.

Overrides:

setRadiusX in class ShapeOval

Parameters:

radiusX - the radius of the arc along X-axis

getRadiusX

public double getRadiusX()

Returns the radius of the arc along X-axis.

Overrides:

getRadiusX in class ShapeOval

Returns:

the radius of the arc along X-axis

setRadiusY

public void setRadiusY(double radiusY)

Sets the radius of the arc along Y-axis.

Overrides:

setRadiusY in class ShapeOval

Parameters:

radiusY - the radius of the arc along Y-axis

getRadiusY

public double getRadiusY()

Returns the radius of the arc along Y-axis.

Overrides:

getRadiusY in class ShapeOval

Returns:

the radius of the arc along Y-axis

setRadius

public void setRadius(double radius)

Description copied from class: ShapeOval

Sets both radiuses of the oval to the same given value, i.e. makes it a circle.

Overrides:

setRadius in class ShapeOval

Parameters:

radius - the circle radius

setAngleStart

public void setAngleStart(double angleStart)

Description copied from class: ShapeArc

Sets the starting angle of the arc (0 means 3 o'clock) in radians, clockwise.

Overrides:

setAngleStart in class ShapeArc

Parameters:

angleStart - the starting angle of the arc

setAngle

public void setAngle(double angle)

Description copied from class: ShapeArc

Sets the the angular extent of the arc in radians, clockwise.

Overrides:

setAngle in class ShapeArc

Parameters:

angle - the the angular extent of the arc

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 base arc center

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 shape along all the axes

Overrides:

setScale in class Shape

Parameters:

scale - the new value of scale, 1 = keep original size

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