com.azalient.api.b.display
Interface IFixture

All Superinterfaces:

IObstacle, IRecord, RecordR, RecordRW, RecordW, SortableData, StoreRecordRW

public interface IFixture
extends IObstacle, StoreRecordRW

A fixture is a 3-dimensional rendered object added to the model, in most cases for decoration. However, it also has a simulation aspect, in that it can be marked as an obstacle, in which case it will be visible to agents, and they will try to walk around it.

Field Summary

static String

NAME_PREFIX The name given to newly created fixture objects is derived from this prefix: Fixture1, Fixture2, etc

Fields inherited from interface com.azalient.api.sim.agents.IObstacle

ZERO_OBSTACLES

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

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

IPolygon	basePolygon() A polygon constructed on the base plane, used for obstruction test
IFixtureCompound	compound() Returns a compound fixture if this is part of a combination of two or more fixtures
void	compound(IFixtureCompound fc) Sets the reference to a compound fixture indicating that this fixture is part of a group
boolean	delete(IUndoStack us) Called when this fixture is deleted.
void	findObstacleCells() Call this after the fixture is moved to re-discover teh obstacle cells in the grid which are occupied by this fixture
boolean	isFixed() Returns true if this (image) fixture is fixed, and cannot be dragged.
boolean	isImage() Returns true if this fixture is a flat 2-dimensional image
boolean	isObstacle() Returns true if this fixture is marked as an obstacle.
IXyz	position() The location of the centre of the base of this fixture
IAngle	rotationZ() The rotation of this fixture around the Z axis, relative to the stored IShape
IXyz	scale() The (x,y,z) scale factors for this object (relative to the stored IShape size)
IShape	shape() The shape object for this feature

Methods inherited from interface com.azalient.api.sim.agents.IObstacle

annotationPoint, uniqueID

Methods inherited from interface com.azalient.api.file.StoreRecordRW

canRename, rename, store

Methods inherited from interface com.azalient.api.file.RecordR

extraSet, finished, isApplicable, isEditable, set

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

name

Methods inherited from interface com.azalient.api.file.RecordW

extraCols, extraGet, extraGetB, extraGetD, extraGetI, extraGetS, extraGetT, get, isVolatile

Field Detail

NAME_PREFIX

static final String NAME_PREFIX

The name given to newly created fixture objects is derived from this prefix: Fixture1, Fixture2, etc

See Also:

Constant Field Values

Method Detail

shape

IShape shape()

The shape object for this feature

position

IXyz position()

The location of the centre of the base of this fixture

scale

IXyz scale()

The (x,y,z) scale factors for this object (relative to the stored IShape size)

rotationZ

IAngle rotationZ()

The rotation of this fixture around the Z axis, relative to the stored IShape

basePolygon

IPolygon basePolygon()

A polygon constructed on the base plane, used for obstruction test

isObstacle

boolean isObstacle()

Returns true if this fixture is marked as an obstacle. If this is false it is just a decoration.

isImage

boolean isImage()

Returns true if this fixture is a flat 2-dimensional image

isFixed

boolean isFixed()

Returns true if this (image) fixture is fixed, and cannot be dragged. This is often set for aerial photos

findObstacleCells

void findObstacleCells()

Call this after the fixture is moved to re-discover teh obstacle cells in the grid which are occupied by this fixture

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

compound

IFixtureCompound compound()

Returns a compound fixture if this is part of a combination of two or more fixtures

compound

void compound(IFixtureCompound fc)

Sets the reference to a compound fixture indicating that this fixture is part of a group

delete

boolean delete(IUndoStack us)

Called when this fixture is deleted. Calling this by itself is not enough to delete the fixture and tidy up the resources.

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