com.anylogic.engine.presentation

Class ShapeTopLevelPresentationGroup

java.lang.Object

com.anylogic.engine.presentation.Shape

com.anylogic.engine.presentation.Shape3D

com.anylogic.engine.presentation.ShapeGroup

com.anylogic.engine.presentation.ShapeTopLevelPresentationGroup

All Implemented Interfaces:

com.anylogic.engine.internal.Child, Locatable2D, Locatable3D, SVGElement, java.io.Serializable, java.lang.Cloneable

public class ShapeTopLevelPresentationGroup
extends ShapeGroup

Top-level group of agent or experiment presentation

Author:

AnyLogic North America, LLC https://anylogic.com

See Also:

Serialized Form

Field Summary

Fields inherited from class com.anylogic.engine.presentation.Shape3D

UNKNOWN_NAME

Constructor Summary

Constructors

Constructor and Description
ShapeTopLevelPresentationGroup(Presentable presentable, boolean ispublic, double x, double y, double z, double rotationXY, java.lang.Object... contents) Constructs a top-level presentation group with specific attributes and possibly with some content

Method Summary

Modifier and Type	Method and Description
void	add(MarkupShape shape) Adds a space markup shape to the group.
Configuration3D	getConfiguration3D() Returns 3D configuration of agent.
ShapeEmbeddedObjectPresentation	getOwner() Returns the owner of this presentation if this is an agent presentation and it is embedded to another agent This method returns null in case the agent is not embedded anywhere or if this is an experiment presentation
java.util.List<java.lang.Object>	getShapes() Returns the collection of shapes in the group (not a copy).
void	insert(int index, MarkupShape shape) Adds a space markup to the group at the specified index (which defines z-order of shape in 2D animation).
boolean	remove(MarkupShape shape) Tries to remove a space markup shape from the group, returns false if the shape was not contained.
void	setOwner_xjal(ShapeEmbeddedObjectPresentation owner) This method shouldn't be called by user.

Methods inherited from class com.anylogic.engine.presentation.ShapeGroup

add, add, add, add, clear, clone, contains, findSVGElement, get, getPresentable, getRotation, getRotationX, getRotationY, getRotationZ, indexOf, initialize_xjal, insert, insert, onDraw, postSVGShapeSpecificAttributes, remove, remove, remove, remove, resetSVGState, restoreOwner, setRotation, setRotationX, setRotationY, setRotationZ, setVisible, size, updateDynamicProperties, updateSVGProperties

Methods inherited from class com.anylogic.engine.presentation.Shape3D

canHandleClick, getDrawMode, getScaleZ, getZ, getZOffset, setDrawMode, setPos, setPos, setPos, setScale, setScale, setScaleZ, setZ

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

executeUserAction, getGroup, getName, getScaleX, getScaleY, getSVGId, getX, getY, isJava2DSwingPresentation, isSVGPresentation, isVisible, onClick, randomPointInside, randomPointInside, removeSVGImage, setScale, setScaleX, setScaleY, setX, setY

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.anylogic.engine.Locatable2D

getX, getY

Constructor Detail

ShapeTopLevelPresentationGroup

public ShapeTopLevelPresentationGroup(Presentable presentable,
                                      boolean ispublic,
                                      double x,
                                      double y,
                                      double z,
                                      double rotationXY,
                                      java.lang.Object... contents)

Constructs a top-level presentation group with specific attributes and possibly with some content

Parameters:

presentable - the presentable object owning this shape

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

x - the x coordinate of group

y - the y coordinate of group

z - the z coordinate of group

rotationXY - the rotation of the group in radians

contents - the (possibly, empty) initial set of shapes (Shape objects, int ids, ReplicatedShape or Light3D objects)

Method Detail

add

public void add(MarkupShape shape)

Adds a space markup shape to the group. Note that it is your responsibility to remove the shape from the another group, if any!

Parameters:

shape - the space markup shape to add

insert

public void insert(int index,
                   MarkupShape shape)

Adds a space markup to the group at the specified index (which defines z-order of shape in 2D animation). Note that it is your responsibility to remove the shape from the another group, if any!

Parameters:

index - index at which the specified markup is to be inserted (from 0 to size(), inclusive)

shape - the space markup shape to add

Since:

7.2

remove

public boolean remove(MarkupShape shape)

Tries to remove a space markup shape from the group, returns false if the shape was not contained.

Parameters:

shape - the space markup shape to remove

Returns:

true if the group contained the shape, false otherwise

getShapes

public java.util.List<java.lang.Object> getShapes()

Returns the collection of shapes in the group (not a copy). The collection can contain either members of type Integer for non-persistent shapes, of class Shape for persistent shapes, and of class ReplicatedShape for replicated shapes. It may also contain 3D lights, cameras and space markup elements.

Overrides:

getShapes in class ShapeGroup

Returns:

the collection of shapes in the group

getOwner

public ShapeEmbeddedObjectPresentation getOwner()

Returns the owner of this presentation if this is an agent presentation and it is embedded to another agent
This method returns null in case the agent is not embedded anywhere or if this is an experiment presentation

Returns:

the owner of this presentation

getConfiguration3D

public Configuration3D getConfiguration3D()

Returns 3D configuration of agent.
Returns null for experiments.

Returns:

3D configuration of agent

setOwner_xjal

@AnyLogicInternalAPI
public void setOwner_xjal(ShapeEmbeddedObjectPresentation owner)

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