desmoj.extensions.visualization2d.engine.model

Class EntityType

java.lang.Object

desmoj.extensions.visualization2d.engine.model.EntityType

All Implemented Interfaces:

ClassBasic

public class EntityType
extends java.lang.Object
implements ClassBasic

All entities of same entity-type has the same basic properties. These are: - same size in animation (width/heigth) - same possible states with same icon for a state - same possible attribute-key's

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

christian.mueller@th-wildau.de For information about subproject: desmoj.extensions.visualization2d please have a look at: http://www.th-wildau.de/cmueller/Desmo-J/Visualization2d/ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SHOW_ICON
static int	SHOW_NAME

Constructor Summary

Constructors

Constructor and Description
EntityType(java.lang.String id, Model model, int width, int height, Attribute[] posStates, java.lang.String[] posAttr, int show)

Method Summary

Modifier and Type	Method and Description
boolean	addPossibleAttribut(java.lang.String attr) add an attribute-key as possible
boolean	existPosibleState(java.lang.String state) check if an state exist
boolean	existPossibleAttribut(java.lang.String key) check if an key exist.
int	getHeight()
java.lang.String	getId()
java.awt.Image	getImage(java.lang.String state) get Image of state
java.lang.String	getImageId(java.lang.String state) get image-id of state
Model	getModell()
java.lang.String[]	getPossibleAttributes() get all possible attribute-key's
java.lang.String[]	getPossibleStates() get all possible states
int	getShow() Show is the sum of EntityType.SHOW_ Flags
int	getWidth()
void	setShow(int show) Show is the sum of EntityType.SHOW_ Flags

Methods inherited from class java.lang.Object

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

Field Detail

SHOW_NAME

public static final int SHOW_NAME

See Also:

Constant Field Values

SHOW_ICON

public static final int SHOW_ICON

See Also:

Constant Field Values

Constructor Detail

EntityType

public EntityType(java.lang.String id,
                  Model model,
                  int width,
                  int height,
                  Attribute[] posStates,
                  java.lang.String[] posAttr,
                  int show)
           throws ModelException

Parameters:

id - EntityTypeId must be unique

modell -

width - pixel-size in animation

height - pixel-size in animation

posStates - Attribute[] with key:state and value:iconId

posAttr - String[] with attribute-keys

show - combination of show-flags

Throws:

ModelException

Method Detail

addPossibleAttribut

public boolean addPossibleAttribut(java.lang.String attr)

add an attribute-key as possible

Parameters:

attr -

Returns:

true, when successful

existPossibleAttribut

public boolean existPossibleAttribut(java.lang.String key)

check if an key exist.

Parameters:

key -

Returns:

true, when key exist

getPossibleAttributes

public java.lang.String[] getPossibleAttributes()

get all possible attribute-key's

Returns:

array of attribute-keys

getId

public java.lang.String getId()

Specified by:

getId in interface ClassBasic

getModell

public Model getModell()

getWidth

public int getWidth()

getHeight

public int getHeight()

getPossibleStates

public java.lang.String[] getPossibleStates()

get all possible states

Returns:

array of states

existPosibleState

public boolean existPosibleState(java.lang.String state)

check if an state exist

Parameters:

state -

Returns:

true, when state exist

getImageId

public java.lang.String getImageId(java.lang.String state)

get image-id of state

Parameters:

state -

Returns:

image-id

getImage

public java.awt.Image getImage(java.lang.String state)
                        throws ModelException

get Image of state

Parameters:

state -

Returns:

image

Throws:

ModelException

getShow

public int getShow()

Show is the sum of EntityType.SHOW_ Flags

Returns:

setShow

public void setShow(int show)

Show is the sum of EntityType.SHOW_ Flags

Parameters:

show -