com.xj.anylogic.engine.presentation
Class Shape3DLine

java.lang.Object
  com.xj.anylogic.engine.presentation.Shape
      com.xj.anylogic.engine.presentation.ShapeLine
          com.xj.anylogic.engine.presentation.Shape3DLine

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, Segment2D, Segment3D, java.io.Serializable, java.lang.Cloneable

public class Shape3DLine
extends ShapeLine
implements Segment3D, com.xj.anylogic.engine.internal.presentation.WorldObject3D_xjal

Persistent 3D line shape. Also visible on 2D animation.
3D surface is actually an extrusion of an ordinary Line 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

Shape3DLine()
Constructs a line with default attributes.

Shape3DLine(boolean ispublic, double x, double y, double z, java.lang.Object color, double dx, double dy, double dz, double width, double zHeight, int style)
Constructs a line with specific attributes.

Method Summary

Shape3DLine	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 line end and start points.
double	getEndZ() Returns the z coordinate of the line end point.
double	getLength() Returns the length of the line.
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 shape 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	setColor(java.awt.Color color) Sets the color of the line.
void	setContextReference_xjal(Presentable contextReference) This method is internal and shouldn't be accessed by user.
void	setDx(double dx) Sets the difference of x coordinates of the line end and start points.
void	setDy(double dy) Sets the difference of y coordinates of the line end and start points.
void	setDz(double dz) Sets the difference of z coordinates of the line end and start points.
void	setEndX(double endx) Sets the x coordinate of the line end point.
void	setEndY(double endy) Sets the y coordinate of the line end point.
void	setEndZ(double endz) Sets the z coordinate of the line end point.
void	setLineStyle(int style) Does nothing: the only supported in 3D line style is solid
void	setLineWidth(double width) Sets the width of the line, 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 shape along all the axes
void	setScale(double sx, double sy) Sets the scales of the shape along x and y axes (z-scale isn't changed)
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 figure
void	setZHeight(double zHeight) Sets the height of the shape along Z-axis

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

contains, draw, getColor, getDx, getDy, getEndX, getEndY, getLineStyle, getLineWidth, getTexture, onClickAt

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.Segment2D

getDx, getDy, getEndX, getEndY, getX, getY

Constructor Detail

Shape3DLine

public Shape3DLine()

Constructs a line with default attributes.

Shape3DLine

public Shape3DLine(boolean ispublic,
                   double x,
                   double y,
                   double z,
                   java.lang.Object color,
                   double dx,
                   double dy,
                   double dz,
                   double width,
                   double zHeight,
                   int style)

Constructs a line with specific attributes.

Parameters:

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

x - the x coordinate of the line start point

y - the y coordinate of the line start point

z - the z coordinate of the line start point

color - color (or Texture) of the line

dx - the difference of x coordinates of the line end and start points

dy - the difference of y coordinates of the line end and start points

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

width - the line width

zHeight - the height of a line along Z-axis

style - the line stroke style (only solid is supported)

Method Detail

setColor

public void setColor(java.awt.Color color)

Sets the color of the line.

Overrides:

setColor in class ShapeLine

Parameters:

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

setDx

public void setDx(double dx)

Sets the difference of x coordinates of the line end and start points.

Overrides:

setDx in class ShapeLine

Parameters:

dx - the new difference of x coordinates of the line end and start points

setDy

public void setDy(double dy)

Sets the difference of y coordinates of the line end and start points.

Overrides:

setDy in class ShapeLine

Parameters:

dy - the new difference of y coordinates of the line end and start points

setDz

public void setDz(double dz)

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

Parameters:

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

getDz

public double getDz()

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

Specified by:

getDz in interface Segment3D

Returns:

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

setEndX

public void setEndX(double endx)

Sets the x coordinate of the line end point.

Overrides:

setEndX in class ShapeLine

Parameters:

endx - the new value of x coordinate of line end

setEndY

public void setEndY(double endy)

Sets the y coordinate of the line end point.

Overrides:

setEndY in class ShapeLine

Parameters:

endy - the new value of y coordinate of line end

setEndZ

public void setEndZ(double endz)

Sets the z coordinate of the line end point.

Parameters:

endz - the new value of z coordinate of line end

getEndZ

public double getEndZ()

Returns the z coordinate of the line end point.

Specified by:

getEndZ in interface Segment3D

Returns:

the z coordinate of the line end

getLength

public double getLength()

Returns the length of the line.

Overrides:

getLength in class ShapeLine

Returns:

the length of the line

setLineWidth

public void setLineWidth(double width)

Sets the width of the line, 0 means thinnest possible

Overrides:

setLineWidth in class ShapeLine

Parameters:

width - the new width of the line

setLineStyle

public void setLineStyle(int style)

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

Overrides:

setLineStyle in class ShapeLine

Parameters:

style - the new style of the line

clone

public Shape3DLine 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 ShapeLine

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 Locatable3D

Specified by:

getZ in interface Segment3D

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

Parameters:

zHeight - the new value of z-height

getZHeight

public double getZHeight()

Returns the height of the shape along Z-axis

Returns:

the height of the shape along Z-axis

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 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)

Sets the scales of the shape along x and y axes (z-scale isn't changed)

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