com.xj.anylogic.engine.presentation
Class Shape3DText

java.lang.Object
  com.xj.anylogic.engine.presentation.Shape
      com.xj.anylogic.engine.presentation.ShapeText
          com.xj.anylogic.engine.presentation.Shape3DText

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

Persistent 3D text shape. Also visible on 2D animation.
Text is located in the horizontal plane and has the upper face only (i.e. it is visible only when looking down on it from +Z direction)

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

Shape3DText()
Constructs a 3D text shape with default attributes.

Shape3DText(boolean ispublic, double x, double y, double z, double rotation, java.awt.Color color, java.lang.String text, java.awt.Font font, int alignment)
Constructs a 3D text shape with specific attributes.

Method Summary

Shape3DText	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	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	setAlignment(int alignment) Sets the alignment of the text shape.
void	setColor(java.awt.Color color) Sets the color of the text.
void	setContextReference_xjal(Presentable contextReference) This method is internal and shouldn't be accessed by user.
void	setFont(java.awt.Font font) Sets the font of the text shape.
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	setText(java.lang.Object text) Sets the text of the text shape.
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

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

contains, draw, getAlignment, getColor, getFont, getText, 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.Locatable2D

getX, getY

Constructor Detail

Shape3DText

public Shape3DText()

Constructs a 3D text shape with default attributes.

Shape3DText

public Shape3DText(boolean ispublic,
                   double x,
                   double y,
                   double z,
                   double rotation,
                   java.awt.Color color,
                   java.lang.String text,
                   java.awt.Font font,
                   int alignment)

Constructs a 3D text shape with specific attributes.

Parameters:

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

x - the x coordinate of the beginning of the first line of the text

y - the y coordinate of the beginning of the first line of the text

z - the z coordinate of the text

rotation - the rotation of the text in radians

color - color of the text

text - the text displayed by the text shape

font - the font used by the text shape

alignment - the alignment of the text shape

Method Detail

setColor

public void setColor(java.awt.Color color)

Sets the color of the text.

Overrides:

setColor in class ShapeText

Parameters:

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

setText

public void setText(java.lang.Object text)

Sets the text of the text shape.

Overrides:

setText in class ShapeText

Parameters:

text - the new text of the text shape

setFont

public void setFont(java.awt.Font font)

Sets the font of the text shape.

Overrides:

setFont in class ShapeText

Parameters:

font - the new font of the text shape

setAlignment

public void setAlignment(int alignment)

Sets the alignment of the text shape.

Overrides:

setAlignment in class ShapeText

Parameters:

alignment - the new alignment of the text shape

clone

public Shape3DText 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 ShapeText

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

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

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