com.anylogic.engine.presentation

Class ShapeAgentPopulationGroup

java.lang.Object

com.anylogic.engine.presentation.Shape

com.anylogic.engine.presentation.Shape3D

com.anylogic.engine.presentation.ShapeGroup

com.anylogic.engine.presentation.ShapeAgentPopulationGroup

All Implemented Interfaces:

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

public class ShapeAgentPopulationGroup
extends ShapeGroup

See Also:

Serialized Form

Field Summary

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

UNKNOWN_NAME

Constructor Summary

Constructors

Constructor and Description
ShapeAgentPopulationGroup(Agent presentable, ShapeDrawMode drawMode, boolean ispublic, AgentList<?> population)

Method Summary

Modifier and Type	Method and Description
void	add(Camera3D camera) Deprecated.
void	add(int shape) Deprecated. This function is deprecated and will be removed in the next release
void	add(Light3D light) Deprecated.
void	add(ReplicatedShape<?> rshape) Deprecated.
void	add(Shape shape) Deprecated.
void	clear() Deprecated.
void	createShapes() Creates missing and removes redundant shapes so that current number of shapes in this replicated shape equals value returned by #getReplication()
ShapeEmbeddedObjectPresentation	createShapeWithStaticProperties_xjal(Agent agent, int index) Creates a new shape with static properties already set.
SVGElement	findSVGElement(long svgId)
S	get(Agent a) Returns the embedded presentation shape shape of the given agent.
java.lang.Object	get(int i) Deprecated.
java.util.Collection<Agent>	getAgents_xjal() This method is internal and shouldn't be called by user.
int	indexOf(java.lang.Object shape) Deprecated.
void	initialize_xjal(java.lang.Object... contents) Deprecated.
void	insert(int index, int shape) Deprecated. This function is deprecated and will be removed in the next release
void	insert(int index, ReplicatedShape<?> rshape) Deprecated.
void	insert(int index, Shape shape) Deprecated.
boolean	remove(Camera3D camera) Deprecated.
boolean	remove(int shape) Deprecated. This function is deprecated and will be removed in the next release
boolean	remove(Light3D light) Deprecated.
boolean	remove(ReplicatedShape<?> rshape) Deprecated.
boolean	remove(Shape shape) Deprecated.
void	resetSVGState()
void	setShapeDynamicProperties_xjal(ShapeEmbeddedObjectPresentation shape, int index) Sets the dynamic properties of a shape with the given index.
int	size() Returns the number of shapes in the group.
void	updateDynamicProperties(boolean publicOnly) Updates dynamic properties of the shape in a given context.
boolean	updateSVGProperties(java.util.List<SVGCommand> output, ShapeDrawMode drawMode, boolean publicOnly, SVGElement owner, SVGElement elbehind) Updates SVG properties of the element that are then sent to the rendering client.

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

clone, contains, getPresentable, getRotation, getRotationX, getRotationY, getRotationZ, getShapes, initialize_xjal, onDraw, postSVGShapeSpecificAttributes, restoreOwner, setRotation, setRotationX, setRotationY, setRotationZ, setVisible

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.internal.Child

restoreOwner

Methods inherited from interface com.anylogic.engine.Locatable2D

getX, getY

Constructor Detail

ShapeAgentPopulationGroup

public ShapeAgentPopulationGroup(Agent presentable,
                                 ShapeDrawMode drawMode,
                                 boolean ispublic,
                                 AgentList<?> population)

Method Detail

updateDynamicProperties

public void updateDynamicProperties(boolean publicOnly)

Description copied from class: Shape

Updates dynamic properties of the shape in a given context.
Method should be overridden for shapes with dynamic properties. Note that you should call super.updateDynamicProperties(publicOnly) at the end of overridden method

Parameters:

publicOnly - if true, the shape is only updated if it is public

createShapes

public void createShapes()

Creates missing and removes redundant shapes so that current number of shapes in this replicated shape equals value returned by #getReplication()

createShapeWithStaticProperties_xjal

@AnyLogicInternalCodegenAPI
public ShapeEmbeddedObjectPresentation createShapeWithStaticProperties_xjal(Agent agent,
                                                                                                         int index)

Creates a new shape with static properties already set. Must be defined in a subclass.

Parameters:

index - the desired shape index

Returns:

a new shape

setShapeDynamicProperties_xjal

@AnyLogicInternalCodegenAPI
public void setShapeDynamicProperties_xjal(ShapeEmbeddedObjectPresentation shape,
                                                                        int index)

Sets the dynamic properties of a shape with the given index. By default does nothing.

Parameters:

shape - the shape

index - the shape index

size

public int size()

Returns the number of shapes in the group.

Overrides:

size in class ShapeGroup

Returns:

the number of shapes in the group

get

public S get(Agent a)

Returns the embedded presentation shape shape of the given agent. Returns null if the given agent isn't contained in this shape.

Parameters:

a - the agent

Returns:

the shape

getAgents_xjal

@AnyLogicInternalAPI
public java.util.Collection<Agent> getAgents_xjal()

This method is internal and shouldn't be called by user.
it may be removed/renamed in future. Returns the unsorted collection of agents - may be inconsistent with the real population state because of shape update sequence

updateSVGProperties

@AnyLogicInternalAPI
public boolean updateSVGProperties(java.util.List<SVGCommand> output,
                                                         ShapeDrawMode drawMode,
                                                         boolean publicOnly,
                                                         SVGElement owner,
                                                         SVGElement elbehind)

Description copied from interface: SVGElement

Updates SVG properties of the element that are then sent to the rendering client. If the element is not yet in the SVG scene, generates "C" command, if it is there, but some properties are out of date, generates "U" command. If SVG drawing of this element is not needed because of public only settings, or permanently not needed, or not supported yet, returns false and does nothing.

Specified by:

updateSVGProperties in interface SVGElement

Overrides:

updateSVGProperties in class ShapeGroup

Parameters:

output - the list of commands to add to

drawMode - TODO

publicOnly - drawing context: if true, only shapes that are marked as public only are updated

owner - the SVG element that serves as a container for this element

elbehind - the SVG element behind this one, or null if none or if order is irrelevant

Returns:

false if element wasn't added to SVG of the given owner. Possible cases are:

• drawing of this element is not needed because of public only settings, permanently not needed or not supported - hen SVG id is not set
• svg element was added to a different place (e.g. GIS map)

, otherwise returns true

resetSVGState

@AnyLogicInternalAPI
public void resetSVGState()

Specified by:

resetSVGState in interface SVGElement

Overrides:

resetSVGState in class ShapeGroup

findSVGElement

@AnyLogicInternalAPI
public SVGElement findSVGElement(long svgId)

Specified by:

findSVGElement in interface SVGElement

Overrides:

findSVGElement in class ShapeGroup

clear

@Deprecated
public void clear()

Deprecated.

Description copied from class: ShapeGroup

Removes all shapes from the group.

Overrides:

clear in class ShapeGroup

initialize_xjal

@Deprecated
public void initialize_xjal(java.lang.Object... contents)

Deprecated.

get

@Deprecated
public java.lang.Object get(int i)

Deprecated.

Description copied from class: ShapeGroup

Returns the shape with the given index. The result may be a shape, replicated shape, 3D light or camera.

Overrides:

get in class ShapeGroup

Parameters:

i - the index of the shape

Returns:

the shape with the given index

indexOf

@Deprecated
public int indexOf(java.lang.Object shape)

Deprecated.

Description copied from class: ShapeGroup

Returns the index of the specified shape (either object of class Shape, or object of class ReplicatedShape) in this group, or -1 if this group does not contain the shape.
More formally, returns the index i such that get( i ) == shape, or -1 if there is no such index.
Note that implementation of this method is very inefficient (has linear complexity)

Overrides:

indexOf in class ShapeGroup

Parameters:

shape - the shape to find index of

Returns:

the index of the shape or -1

add

@Deprecated
public void add(Shape shape)

Deprecated.

Description copied from class: ShapeGroup

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

Overrides:

add in class ShapeGroup

Parameters:

shape - the shape to add

add

@Deprecated
public void add(int shape)

Deprecated. This function is deprecated and will be removed in the next release

add

@Deprecated
public void add(ReplicatedShape<?> rshape)

Deprecated.

Description copied from class: ShapeGroup

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

Overrides:

add in class ShapeGroup

Parameters:

rshape - the replicated shape to add

insert

@Deprecated
public void insert(int index,
                                Shape shape)

Deprecated.

Description copied from class: ShapeGroup

Adds a persistent shape 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!

Overrides:

insert in class ShapeGroup

Parameters:

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

shape - the shape to add

insert

@Deprecated
public void insert(int index,
                                int shape)

Deprecated. This function is deprecated and will be removed in the next release

insert

@Deprecated
public void insert(int index,
                                ReplicatedShape<?> rshape)

Deprecated.

Description copied from class: ShapeGroup

Adds a replicated shape 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!

Overrides:

insert in class ShapeGroup

Parameters:

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

rshape - the replicated shape to add

remove

@Deprecated
public boolean remove(Shape shape)

Deprecated.

Description copied from class: ShapeGroup

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

Overrides:

remove in class ShapeGroup

Parameters:

shape - the shape to remove

Returns:

true if the group contained the shape, false otherwise

remove

@Deprecated
public boolean remove(int shape)

Deprecated. This function is deprecated and will be removed in the next release

remove

@Deprecated
public boolean remove(ReplicatedShape<?> rshape)

Deprecated.

Description copied from class: ShapeGroup

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

Overrides:

remove in class ShapeGroup

Parameters:

rshape - the replicated shape to remove

Returns:

true if the group contained the shape, false otherwise

add

@Deprecated
public void add(Light3D light)

Deprecated.

Description copied from class: ShapeGroup

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

Overrides:

add in class ShapeGroup

Parameters:

light - the light to add

remove

@Deprecated
public boolean remove(Light3D light)

Deprecated.

Description copied from class: ShapeGroup

Tries to remove a light from the group, returns false if the light was not contained.

Overrides:

remove in class ShapeGroup

Parameters:

light - the light to remove

Returns:

true if the group contained the light, false otherwise

add

@Deprecated
public void add(Camera3D camera)

Deprecated.

Description copied from class: ShapeGroup

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

Overrides:

add in class ShapeGroup

Parameters:

camera - the camera to add

remove

@Deprecated
public boolean remove(Camera3D camera)

Deprecated.

Description copied from class: ShapeGroup

Tries to remove a camera from the group, returns false if the camera was not contained.

Overrides:

remove in class ShapeGroup

Parameters:

camera - the camera to remove

Returns:

true if the group contained the camera, false otherwise