com.azalient.api.a.model
Interface IDisplay

All Superinterfaces:

IModule, IPage

public interface IDisplay
extends IModule, IPage

A handle to the objects associated with the Display component

Field Summary

Fields inherited from interface com.azalient.api.a.tables.IModule

NONE

Fields inherited from interface com.azalient.api.a.tables.IPage

ZERO

Method Summary

void	addNonPickableSelection(Object obj)
IFeature	apiFeature(String name) Create a new feature with the given label.
IStore<IAspect>	aspects() A store of aspects, where an aspect is the set of colours and on/off settings for each layer
String[]	avatarGroups() Return an array of the names of the "avatar" groups - an avatar group is used for 3D person shapes in Detailed drawing mode
IStore<IFeature>	features() A store of features also known as layers
ICreator	fixtureCreator() [Internal method used for pasting]
IStore<IFixture>	fixtures() A store of fixtures, which are objects that use a pre-defined shape for decorations in Detailed drawing mode
IStore<IShape>	fixtureShapes() A store of fixture (building) shapes used in Detailed drawing mode
ICreator	labelCreator() [Internal method used for pasting]
IStore<ILabel>	labels() A store of text message labels
IStore<IShape>	personShapes() A store of person shapes used in Detailed drawing mode
IStore<IShape>	pictureShapes() A store of images - map overlays, signs etc.
void	removeNonPickableSelection(Object obj)
Object	selectionFirst(Class<?> objectClass) Return the first selected object with the given class.
Object[]	selectionsAll(Class<?> objectClass) Return all selected object with the given class.
String[]	shapeGroups() Return an array of the names of the shape groups - a shape group is used for 3D vehicle shapes in Detailed drawing mode
ICompoundStore<IShape>	shapes() A compound store of all shapes
ICreator	symbolCreator() [Internal method used for pasting]
ICreator	symbolPointCreator() [Internal method used for pasting]
IStore<INetPoint>	symbolPoints() A store of points used for the symbols
IStore<ISymbol>	symbols() A store of extruded polygon decration symbols.
IStore<ITag>	tags() A store of tags
double	textSize(TextType type) Returns the text size for the given TextType, from the Display / Text Sizes window
void	textSize(TextType type, double size) Sets the text size for the given TextType, from the Display / Text Sizes window
IStore<ITextSize>	textSizes() A store of text sizes, as used in Display / Text Sizes
IStore<IShape>	vehicleShapes() A store of vehicle shapes used in Detailed drawing mode
IStore<IView>	views() A store of views, as shown in the views panel

Methods inherited from interface com.azalient.api.a.tables.IModule

addTable, baseName, childModules, destroy, open, open, pageName, pageType, parentModule, rename, save, save, table, verify

Methods inherited from interface com.azalient.api.a.tables.IPage

baseName, pageName, pageType

Method Detail

personShapes

IStore<IShape> personShapes()

A store of person shapes used in Detailed drawing mode

vehicleShapes

IStore<IShape> vehicleShapes()

A store of vehicle shapes used in Detailed drawing mode

fixtureShapes

IStore<IShape> fixtureShapes()

A store of fixture (building) shapes used in Detailed drawing mode

pictureShapes

IStore<IShape> pictureShapes()

A store of images - map overlays, signs etc. These are stored as "flat" shapes

shapes

ICompoundStore<IShape> shapes()

A compound store of all shapes

fixtures

IStore<IFixture> fixtures()

A store of fixtures, which are objects that use a pre-defined shape for decorations in Detailed drawing mode

labels

IStore<ILabel> labels()

A store of text message labels

symbols

IStore<ISymbol> symbols()

A store of extruded polygon decration symbols. These are like areas or zones, but have no function in the simulation

symbolPoints

IStore<INetPoint> symbolPoints()

A store of points used for the symbols

tags

IStore<ITag> tags()

A store of tags

features

IStore<IFeature> features()

A store of features also known as layers

aspects

IStore<IAspect> aspects()

A store of aspects, where an aspect is the set of colours and on/off settings for each layer

views

IStore<IView> views()

A store of views, as shown in the views panel

textSizes

IStore<ITextSize> textSizes()

A store of text sizes, as used in Display / Text Sizes

labelCreator

ICreator labelCreator()

[Internal method used for pasting]

Internal - Not recommended for use. Public as a side-effect of implementation method

symbolPointCreator

ICreator symbolPointCreator()

[Internal method used for pasting]

Internal - Not recommended for use. Public as a side-effect of implementation method

symbolCreator

ICreator symbolCreator()

[Internal method used for pasting]

Internal - Not recommended for use. Public as a side-effect of implementation method

fixtureCreator

ICreator fixtureCreator()

[Internal method used for pasting]

Internal - Not recommended for use. Public as a side-effect of implementation method

selectionsAll

Object[] selectionsAll(Class<?> objectClass)

Return all selected object with the given class. For example

  ILink[] allSelectedLinks = API.model().display().selectionsAll(ILink.class);
 

selectionFirst

Object selectionFirst(Class<?> objectClass)

Return the first selected object with the given class. For example

  ILink firstSelectedLink = API.model().display().selectionFirst(ILink.class);
 

addNonPickableSelection

void addNonPickableSelection(Object obj)

removeNonPickableSelection

void removeNonPickableSelection(Object obj)

avatarGroups

String[] avatarGroups()

Return an array of the names of the "avatar" groups - an avatar group is used for 3D person shapes in Detailed drawing mode

shapeGroups

String[] shapeGroups()

Return an array of the names of the shape groups - a shape group is used for 3D vehicle shapes in Detailed drawing mode

textSize

double textSize(TextType type)

Returns the text size for the given TextType, from the Display / Text Sizes window

textSize

void textSize(TextType type,
              double size)

Sets the text size for the given TextType, from the Display / Text Sizes window

apiFeature

IFeature apiFeature(String name)

Create a new feature with the given label. This will be added to the layer pane.