CompositeLine (Tensegrity API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.tensegrity.composite
Interface CompositeLine

All Superinterfaces:: Attributable, AttributableOnSet, BaseComposite, BaseInteractable, InteractableLine

All Known Subinterfaces:: VisualEdgeComposite

public interface CompositeLine
extends BaseComposite, InteractableLine

A CompositeLine is a specialization of the BaseComposite interface. Therefore, it is recommended that you read the documentation of the BaseComposite interface first to acquire a basic understanding of this interface's inherited responsibility.

The CompositeLine interface is used whenever a line is drawn or two composites are connected with a link. This connecting edge is made up of a CompositeLine - a Composite that holds a line and behaves differently than normal composites.

The CompositeLine interface supplements the BaseComposite behavior by managing a set of Coordinate objects that are used by a parent CoordinateSystem.

To deal with the coordinates of a CompositeLine, you may use the following methods:

Coordinate getStartingLocation()
void setStartingLocation(Coordinate)
Coordinate getEndingLocation()
void setEndingLocation(Coordinate)
Coordinate[] getCoordinates()
void setCoordinates(Coordinate[])
int getCoordinateCount()
Coordinate getCoordinateAt(int)
void setCoordinateAt(int, Coordinate)
void addCoordinate(Coordinate)
void insertCoordinate(int, Coordinate)
void insertCoordinate(int, Coordinate, Coordinate[])
void removeCoordinate(int)
void removeCoordinates(int, int)

A CompositeLine object fires events for every change that can happen to it. In order to be notified about these events, you have to programmatically register an object that implements the CompositeLineListener interface. For more information about this interface, please take a closer look at the documentation for CompositeLineListener and CompositeLineEvent.

Some of the events generated by a CompositeLine are vetoable, which means that the processing of an event can be programmatically stopped. In order to veto an event, you have to register a VetoableCompositeLineListener. For more information about this interface, please take a closer look at the documentation for VetoableCompositeLineListener.

For more information about the event mechanism in the tensegrity frameworks, please see interface EventListenerTag and class EventMultiplexer.

The methods a CompositeLine provides to support the event mechanism are:

Version:: $Id: CompositeLine.java,v 1.59 2005/06/16 16:13:43 AndreasEbbert Exp $
Author:: MichaelKegel

Field Summary
`static int`	`EVENT_MASK_CHANGE` Constant that tells about the different events or groups of events and can be used with `BaseComposite.enableEvents(int)` to turn them on and `BaseComposite.disableEvents(int)` to turn them off.
`static int`	`EVENT_MASK_MANIPULATE` Constant that tells about the different events or groups of events and can be used with `BaseComposite.enableEvents(int)` to turn them on and `BaseComposite.disableEvents(int)` to turn them off.
`static int`	`EVENT_MASK_MOVE` Constant that tells about the different events or groups of events and can be used with `BaseComposite.enableEvents(int)` to turn them on and `BaseComposite.disableEvents(int)` to turn them off.
`static int`	`LABEL_POSITION_CENTER` Deprecated. use SIGN_XXX position constants instead
`static int`	`LABEL_POSITION_CENTER_END` Deprecated. use SIGN_XXX position constants instead
`static int`	`LABEL_POSITION_CENTER_START` Deprecated. use SIGN_XXX position constants instead
`static int`	`LABEL_POSITION_FREE` Deprecated. use SIGN_XXX position constants instead
`static int`	`LABEL_POSITION_HEAD` Deprecated. use SIGN_XXX position constants instead
`static int`	`LABEL_POSITION_HEAD_END` Deprecated. use SIGN_XXX position constants instead
`static int`	`LABEL_POSITION_HEAD_START` Deprecated. use SIGN_XXX position constants instead
`static int`	`LABEL_POSITION_TAIL` Deprecated. use SIGN_XXX position constants instead
`static int`	`LABEL_POSITION_TAIL_END` Deprecated. use SIGN_XXX position constants instead
`static int`	`LABEL_POSITION_TAIL_START` Deprecated. use SIGN_XXX position constants instead
`static int`	`LABEL_POSITION_UNKNOWN` Deprecated. use SIGN_XXX position constants instead
`static int`	`SIGN_ANCHOR_BEGIN`
`static int`	`SIGN_ANCHOR_CENTER`
`static int`	`SIGN_ANCHOR_END`
`static int`	`SIGN_ANCHOR_FREE`
`static int`	`SIGN_PLACEMENT_CENTER`
`static int`	`SIGN_PLACEMENT_FREE`
`static int`	`SIGN_PLACEMENT_HEAD`
`static int`	`SIGN_PLACEMENT_TAIL`
`static int`	`TYPE_CURVED` Constant to specify the type of the `CompositeLine`.
`static int`	`TYPE_DYNAMIC` Constant to specify the type of the `CompositeLine`.
`static int`	`TYPE_ORTHOGONAL` Constant to specify the type of the `CompositeLine`.
`static int`	`TYPE_STRAIGHT` Constant to specify the type of the `CompositeLine`.

Fields inherited from interface com.tensegrity.composite.BaseComposite

DELEGATE_INFOVALUE, EVENT_MASK_MOUSE, EVENT_MASK_SELECT, GENERAL_INFOVALUE, NON_INFOVALUE

Fields inherited from interface com.tensegrity.generic.attribute.AttributableOnSet

TREE_SUBSET_POSTFIX

Method Summary
`void`	`addCompositeLineListener(CompositeLineListener listener)` Adds the given `CompositeLineListener` to the `CompositeLine`s internal structure, such that the listener is informed about every event that occurs.
`void`	`addCoordinate(Coordinate coordinate)` Adds the `Coordinate` given by `coordinate` to the end of the `CompositeLine`s actual coordinates.
`void`	`addVetoableCompositeLineListener(VetoableCompositeLineListener listener)` Adds the given `VetoableCompositeLineListener` to the `CompositeLine`s internal structure, such that the listener is informed about every event that occurs.
`void`	`applyState(CompositeLineState state)` Applies the `CompositeLineState` given by `state` to the `CompositeLine`.
`CompositeLine`	`deepCopy()` Deep copies a `CompositeLine`.
`Coordinate`	`getCoordinateAt(int index)` Returns the `Coordinate` at the index given by `index` from the `CompositeLine`s current coordinates.
`int`	`getCoordinateCount()` Returns the current number of `Coordinates` the `CompositeLine` consist of.
`Coordinate[]`	`getCoordinates()` Returns an array of the current `Coordinates` the `CompositeLine` consist of.
`Coordinate`	`getEndingLocation()` Returns the ending `Coordinate` of the `CompositeLine`.
`java.lang.String`	`getLabel()` Deprecated. use .setSignVisible() and .adjustGeometry() instead [NOTICE: method will be removed in the near future]
`Coordinate`	`getLabelLocation()` Deprecated. use .getSign().getLocation() instead [NOTICE: method will be removed in the near future]
`int`	`getLabelPositioning()` Deprecated. use .getSignPosition() or .getSignLinePosition() instead [NOTICE: method will be removed in the near future]
`Size`	`getLabelSize()` Deprecated. use .getSign().getSize() instead [NOTICE: method will be removed in the near future]
`MarkerFormat`	`getMarkerBegin()` Returns the `MarkerFormat` that is currently used to draw a marker at the beginning coordinate of the `CompositeLine`.
`MarkerFormat`	`getMarkerEnd()` Returns the `MarkerFormat` that is currently used to draw a marker at the ending coordinate of the `CompositeLine`.
`Coordinate[]`	`getReferenceCoordinates()` Returns an array of `Coordinate`s that represents the reference coordinates the `CompositeLine` currently provides.
`int[]`	`getSegmentTypes()` Returns an int-array that represent the segment types the `CompositeLine` currently provides.
`Composite`	`getSign()`
`int`	`getSignAnchor()`
`int`	`getSignPlacement()`
`Coordinate`	`getStartingLocation()` Returns the starting `Coordinate` of the `CompositeLine`.
`CompositeLineState`	`getState()` Returns a `CompositeLineState` instance that can be used to reset the state of the `CompositeLine` to the state that is stored into the `CompositeLineState`.
`StrokeFormat`	`getStroke()` Returns the `StrokeFormat` that is currently used to draw the `CompositeLine`.
`int`	`getType()` Returns the type of the line.
`void`	`insertCoordinate(int index, Coordinate coordinate)` Inserts the `Coordinate` given by `coordinate` at the index given by `index`.
`void`	`insertCoordinate(int index, Coordinate coordinate, Coordinate[] refCoordinate)` Inserts the `Coordinate` given by `coordinate` at the index given by `index`.
`boolean`	`isEachPointInteractionAllowed()` Returns a `boolean` that indicates whether it is allowed for the user to interact at each point of the `CompositeLine` or not.
`boolean`	`isSignVisible()` Returns a `boolean` that indicates whether the current sign of the `CompositeLine` is visible or not.
`void`	`layoutLabel(Coordinate location)` Deprecated. use .getSign().setLocation() [NOTICE: method will be removed in the near future]
`void`	`removeCompositeLineListener(CompositeLineListener listener)` Removes the given `CompositeLineListener` from the `CompositeLine`s internal structure, such that the listener is no longer informed about occurring events.
`void`	`removeCoordinate(int index)` Removes the `Coordinate` at the index given by `index` from the `CompositeLine`s coordinates.
`void`	`removeCoordinates(int index1, int index2)` Removes all `Coordinates` between the two indices given by `index1` and `index2` from the `CompositeLine`s actual `Coordinate`s.
`void`	`removeVetoableCompositeLineListener(VetoableCompositeLineListener listener)` Removes the given `VetoableCompositeLineListener` from the `CompositeLine`s internal structure, such that the listener is no longer informed about occurring events.
`void`	`setCoordinateAt(int index, Coordinate coordinate)` Sets the `Coordinate` given by `coordinate` at the index given by `index` of the `Composites` current coordinates.
`void`	`setCoordinates(Coordinate[] coordinates)` Sets the `Coordinates` given by `coordinates` as the `CompositeLine`s coordinates.
`void`	`setEachPointInteractionAllowed(boolean allowEachPointInteraction)` Sets the state of the each-point-interaction flag to the value given by `allowEachPointInteraction`.
`void`	`setEndingLocation(Coordinate coordinate)` Sets the `Coordinate` given by `Coordinate` as the new ending coordinate of the `CompositeLine`.
`void`	`setLabel(java.lang.String text)` Deprecated. use .setSignVisible() and .adjustGeometry() instead [NOTICE: method will be removed in the near future]
`void`	`setLabel(Transform2D xform_context, ScaleValues scalevalues, java.lang.String text)` Deprecated. use .setSignVisible() and .adjustGeometry() instead [NOTICE: method will be removed in the near future]
`void`	`setLabelPositioning(int positioning)` Deprecated. use .setSignAnchor() and/or .setSignPlacement() instead [NOTICE: method will be removed in the near future]
`void`	`setLabelVisible(Transform2D xform_context, ScaleValues scalevalues, boolean visible)` Deprecated. use .setSignVisible() and .adjustGeometry() instead [NOTICE: method will be removed in the near future]
`void`	`setMarkerBegin(MarkerFormat marker)` Sets the `MarkerFormat` given by `marker` as the new `MarkerFormat>` used to draw a marker at the beginning coordinate of the `CompositeLine`.
`void`	`setMarkerEnd(MarkerFormat marker)` Sets the `MarkerFormat` given by `marker` as the new `MarkerFormat>` used to draw a marker at the ending coordinate of the `CompositeLine`.
`void`	`setReferenceCoordinates(Coordinate[] coordinatesRef)` Sets the reference `Coordinates` given by `coordinates` as the `CompositeLine`s reference coordinates.
`void`	`setSegmentTypes(int[] segmentTypesNew)` Sets the segment types for the `PolygonLine` to the values given by `segmentTypesNew`.
`void`	`setSign(Composite sign)`
`void`	`setSignAnchor(int anchor)`
`void`	`setSignPlacement(int placement)`
`void`	`setSignVisible(boolean visible)` Sets the visibility state of the `CompositeLine`'s sign to the value given by `visible`.
`void`	`setStartingLocation(Coordinate coordinate)` Sets the `Coordinate` given by `coordinate` as the new starting coordinate of the `CompositeLine`.
`void`	`setStroke(StrokeFormat stroke)` Sets the `StrokeFormat` given by `stroke` as the new `StrokeFormat` used to draw the `CompositeLine`.
`void`	`setType(int type)` Sets the type of the line.
`void`	`translatePoints(int indexStart, int indexEnd, int offsetX, int offsetY)` Translates the given range of points by the values of `offsetX` and `offsetY`.

Methods inherited from interface com.tensegrity.composite.BaseComposite

addPrimitive, adjustGeometry, adjustGeometry, applyGeometry, applyStyle, areEventsEnabled, disableEvents, draw, draw, drawComposite, enableEvents, getBaseCompositeContainer, getEventMask, getGeometryName, getInfoValue, getInfoValueIdentifier, getName, getPrimitiveIterator, getShadowColor, getShadowDirection, getStyleName, internalSetGeometryName, internalSetStyleName, isDeletable, isShadowVisible, registerAttributeConstraint, registerEventMediator, registerVetoableEventMediator, removeAllPrimitives, removePrimitive, setBaseCompositeContainer, setDeletable, setEventMask, setInfoValue, setInfoValue, setName, setShadowColor, setShadowDirection, setShadowVisible, unregisterAttributeConstraint

Methods inherited from interface com.tensegrity.generic.attribute.AttributableOnSet

addAttributableOnSetListener, areAttributableEventsEnabled, disableAttributableEvents, enableAttributableEvents, getAttributes, getAttributesTree, removeAttributableOnSetListener, setAttributes, setAttributesTree

Methods inherited from interface com.tensegrity.generic.attribute.Attributable

getAttribute, getAttributeType, getAttributeValue, setAttribute, setAttributeValue

Methods inherited from interface com.tensegrity.graphics.interaction.BaseInteractable

getBoundingBox, getInteractionDescriptor, getMoveItem, hits, internalEnableSelection, internalSelect, internalSetSelected, isMovable, isSelectable, isSelected, mouseClick, mouseDown, mouseEnter, mouseExit, mouseUp, postActing, preActing, select, setMovable, setSelectable, setSelected, startAction, stopAction

Methods inherited from interface com.tensegrity.graphics.interaction.InteractableLine

calculateCoordinates, getActionMode, isManipulable, setManipulable

Field Detail