GeometryDescriptor (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.geometry
Interface GeometryDescriptor

All Known Implementing Classes:: DefaultGeometryDescriptor

public interface GeometryDescriptor

A GeometryDescriptor represents a grouping of one or more basic items of type GeometryItem. Each aggregated item is represented as a uniquely named GeometryDescriptorItem.

Each GeometryDescriptor definition consists of a name, a type, a CoordinateSystem and, of course, a list of atomic parts of type GeometryDescriptorItem. The Type attribute can be one of the following string enumerations: Composite, CompositeLine or CompositeGroup.

A basic definition of a GeometryDescriptor looks like this:

 <!-- a minimal geometry descriptor -->
 <list name="GeometryDescriptor">
   <attribute name="Name" value="GEOMETRY_DESCRIPTOR_NAME"/>
   <attribute name="Type" value="GEOMETRY_DESCRITPOR_TYPE"/>
   <list name="CoordinateSystem">
     <attribute name="ScaleX" value="MINIMUM_VALUE, MAXIMUM_VALUE" />
     <attribute name="ScaleY" value="MINIMUM_VALUE, MAXIMUM_VALUE" />
   </list>
   <!-- optional attributes of the geometry descriptor -->
   <set name="Attributes">
     <attribute name="ATTRIBUTENAME" 
 			type="ATTRIBUTETYPE" 
 			value="ATTRIBUTEVALUE" />
 
     [...]
 
   </set>
   <list name="DescriptorItems">
     <list name="DescriptorItem">
 
     [...]
 
     </list>
   </list>
 </list>

The following lists show the GeometryDescriptor types that are currently supported and their attributes, if available:

CompositeLine: Definition of a CompositeLine:

Name	Value Type	Description
Type	Constant	Specifies the line type. The following types are currently supported: dynamic straight orthogonal LineCountAndLength
isLabelVisible	Boolean	Specifies whether the label is visible or not.
LabelPositioning	Constant	Specifies the label positioning. The following positioning types are currently supported: Free Head HeadStart HeadEnd Tail TailStart TailEnd Center CenterStart CenterEnd

Composite: Definition of a Composite.

Name	Value Type	Description
MinimumSize	Size	The minimum size of the `Composite`.

CompositeGroup: Definition of a CompositeGroup.

Attribute Name	Value Type	Description
HorizontalBorderToContent	Integer	The horizontal distance between the border and the elements inside the `CompositeGroup`.
VerticalBorderToContent	Integer	The vertical distance between the border and the elements inside the `CompositeGroup`.
Foldable	Boolean	Specifies whether the `CompositeGroup` should be foldable or not.
FoldedSize	Size	The size of the `CompositeGroup` when folded.
FoldStateButtonSize	Size	The size of the button the `CompositeGroup` is folded with.

The coordinate system specifies the inner measurement for the object and is defined by a list within the GeometryDescriptor. An example of such a list is below:

 <list name="CoordinateSystem">
  <attribute name="ScaleX" value="MINIMUM_VALUE, MAXIMUM_VALUE" />
  <attribute name="ScaleY" value="MINIMUM_VALUE, MAXIMUM_VALUE" />
  [...]

As you can see above, the definition is divided into two attributes that define the extensions of the coordinate system in the X and Y directions. Note that the coordinate system; must start at the origin. A well-defined coordinate system looks as follows:

 <list name="CoordinateSystem">
  <attribute name="ScaleX" value="0, 500" />
  <attribute name="ScaleY" value="0, 500" />
  [...]

Version:: $Id: GeometryDescriptor.java,v 1.26 2005/06/17 09:44:56 AndreasEbbert Exp $
Author:: MichaelKegel
See Also:: GeometryDescriptorItem

Field Summary
`static int`	`COMPOSITE_DESCRIPTOR` Constants that define the type of a `GeometryDescriptor`.
`static int`	`COMPOSITEGROUP_DESCRIPTOR` Constants that define the type of a `GeometryDescriptor`.
`static int`	`COMPOSITELABEL_DESCRIPTOR` Constants that define the type of a `GeometryDescriptor`.
`static int`	`COMPOSITELINE_DESCRIPTOR` Constants that define the type of a `GeometryDescriptor`.
`static int`	`COMPOSITESWIMLANE_DESCRIPTOR` Constants that define the type of a `GeometryDescriptor`.
`static int`	`COMPOSITETABLE_COLUMN_DESCRIPTOR` Constants that define the type of a `GeometryDescriptor`.
`static int`	`COMPOSITETABLE_DESCRIPTOR` Constants that define the type of a `GeometryDescriptor`.
`static int`	`COMPOSITETABLE_ROW_DESCRIPTOR` Constants that define the type of a `GeometryDescriptor`.
`static int`	`COMPOSITEVIEW_DESCRIPTOR` Constants that define the type of a `GeometryDescriptor`.
`static int`	`DESCRIPTOR_TYPE_MAX` This constant that tells you about the maximum number of types currently defined.

Method Summary
`AttributeSet`	`getAttributes()` Returns an `AttributeSet` that holds the various attributes of this `GeometryDescriptor`.
`CoordinateSystem`	`getCoordinateSystem()` Returns the `CoordinateSystem` of the geometry.
`GeometryDescriptorItem`	`getItem(java.lang.String name)` Returns the `GeometryDescriptorItem` with the name given by `name`.
`java.lang.String`	`getName()` Returns the name of the `GeometryDescriptor`.
`int`	`getType()` Returns the type of the `GeometryDescriptor`.
`java.util.Iterator`	`iteratorItems()` This method returns an iterator which steps over the `GeometryItem`s provided by this `GeometryDescriptor` object.

Field Detail