Package com.inductiveautomation.rm.shape

Class RMPolygonShape

java.lang.Object

com.inductiveautomation.rm.base.RMListenerList

com.inductiveautomation.rm.base.RMObject

com.inductiveautomation.rm.shape.RMShape

com.inductiveautomation.rm.shape.RMParentShape

com.inductiveautomation.rm.shape.RMPolygonShape

All Implemented Interfaces:

Archivable, DeepChangeListener, RMPropertyChanger, RMTypes, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

Direct Known Subclasses:

RMAnimPathShape, RMLineShape.ArrowHead, RMPencilShape, RMScene3D.RMShape3D

public class RMPolygonShape
extends RMParentShape

This class is an RMShape subclass that encapsulates an arbitrary path.

(kathy): No properties to annotate.

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.rm.base.RMTypes

RMTypes.Align, RMTypes.AlignX, RMTypes.AlignY

Field Summary

Fields inherited from class com.inductiveautomation.rm.shape.RMShape

BINDING_PROP_NAME, STROKE_BORDER, STROKE_DOUBLE, STROKE_HIDDEN, STROKE_SHAPE

Constructor Summary

Constructors

Constructor	Description
RMPolygonShape()	Creates a new empty polygon shape.
RMPolygonShape(RMPath aPath)	Creates a new polygon shape for the given path.

Method Summary

Modifier and Type	Method	Description
RMPolygonShape	clone()	Standard clone implementation.
protected void	fromXMLShape(RXArchiver anArchiver, RXElement anElement)	XML unarchival.
RMPath	getPath()	Returns the path for this polygon shape.
RMTransform	getPathTransform()	Returns the matrix which transforms from path space to this shape's space (path space is arbitrarily defined, and always gets scaled to fit exactly into getBoundsInside()).
void	paintShape(RMShapePainter aPntr)	Handles painting a polygon shape.
void	resetPath(RMPath newPath)	Replace the polygon's current path with a new path, adjusting the shape's bounds to match the new path.
void	setPath(RMPath aPath)	Sets the path for this polygon shape.
boolean	superSelectable()	Editor method - indicates that this shape can be super selected.
protected RXElement	toXMLShape(RXArchiver anArchiver)	XML archival.

Methods inherited from class com.inductiveautomation.rm.shape.RMParentShape

addChild, addChild, addChild, addChild, addLayoutChild, bringShapesToFront, cloneDeep, computePrefHeight, computePrefWidth, divideShapeFromTop, fromXML, fromXMLChildren, getBoundsOfChildren, getChild, getChildArray, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWithClass, getChildrenWithClass, getChildWithClass, getChildWithName, getLayout, getNeedsLayout, getSourceURL, indexOfChild, isHittable, isShowing, isSourceURLSet, layout, layoutChildren, relayout, removeChild, removeChild, removeChildren, removeLayoutChild, rpgAll, rpgChildren, sendShapesToBack, setHeight, setLayout, setNeedsLayout, setSourceURL, setWidth, toXML, toXMLChildren

Methods inherited from class com.inductiveautomation.rm.shape.RMShape

acceptsChildren, acceptsMouse, addBinding, addBinding, addDeepChangeListener, addMouseListener, animUpdate, bounds, childrenSuperSelectImmediately, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, createDivideShapeRemainder, deepChange, divideShapeFromEdge, get, get, getAlignment, getAlignmentX, getAlignmentY, getAncestor, getAncestorCount, getAncestorInCommon, getAnimator, getAnimator, getAutosizing, getAutosizingDefault, getBestHeight, getBestHeight, getBestWidth, getBestWidth, getBinding, getBinding, getBindingCount, getBindings, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getChildAnimator, getChildAnimator, getChildClipShape, getClipShape, getColor, getDashArrayString, getDashPhase, getDatasetEntity, getDatasetKey, getDisplayedFill, getDisplayedStroke, getDocument, getEffect, getEventAdapter, getFill, getFont, getFormat, getFrame, getFrameHeight, getFrameMaxX, getFrameMaxY, getFrameWidth, getFrameX, getFrameXY, getFrameY, getHeight, getHover, getLayoutInfo, getMaskPath, getMaxX, getMaxY, getMinHeight, getMinHeight, getMinWidth, getMinWidth, getName, getOpacity, getOpacityDeep, getOutline, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageShape, getParent, getParent, getPathInBounds, getPrefHeight, getPrefHeight, getPrefWidth, getPrefWidth, getPropertyNameMapped, getPropertyNames, getPropertyNames, getRoll, getRootShape, getRSS, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSkewX, getSkewY, getStroke, getStrokeColor, getStrokeOnTop, getStrokeStyle, getStrokeWidth, getTextColor, getTimeline, getTimeline, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getURL, getVisbileBounds, getVisibleBounds, getVisibleBounds, getVisibleBounds, getWidth, getX, getXY, getXYP, getY, height, indexOf, intersects, isAncestor, isAnimProperty, isDeletable, isDescendant, isEditing, isEnabled, isFontSet, isHittable, isLocked, isMinHeightSet, isMinWidthSet, isPrefHeightSet, isPrefWidthSet, isRoot, isRSS, isShowing, isUnderlined, isUseFill, isUseStroke, isViewing, isVisible, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, offsetXY, page, pageMax, paint, paintShapeAll, paintShapeChildren, paintShapeOver, propertyChange, put, removeBinding, removeBinding, removeDeepChangeListener, removeFromParent, removeMouseListener, repaint, repaint, resolvePageReferences, rpgBindings, rpgShape, setAlignment, setAlignmentX, setAlignmentY, setAutosizing, setBestHeight, setBestSize, setBounds, setBounds, setColor, setDashArrayString, setDashPhase, setEffect, setEnabled, setFill, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHover, setLayoutInfo, setLocked, setMinHeight, setMinSize, setMinWidth, setName, setOpacity, setOutline, setParent, setPrefHeight, setPrefWidth, setRoll, setScaleX, setScaleXY, setScaleY, setShowing, setSize, setSize, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setStrokeStyle, setStrokeWidth, setTextColor, setTime, setTimeline, setUnderlined, setURL, setUseFill, setUseStroke, setVisible, setX, setXY, setXY, setXYP, setY, shapeHidden, shapeShown, toString, undoerDisable, undoerEnable, undoerSetUndoTitle, width, x, y

Methods inherited from class com.inductiveautomation.rm.base.RMObject

addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, getPCEvent, removePropertyChangeListener, sendPropertyChange

Methods inherited from class com.inductiveautomation.rm.base.RMListenerList

addListener, getListener, getListenerCount, getListenerCount, getListenerList, getListeners, hasListeners, removeListener

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RMPolygonShape

public RMPolygonShape()

Creates a new empty polygon shape.

RMPolygonShape

public RMPolygonShape(RMPath aPath)

Creates a new polygon shape for the given path.

Method Detail

getPath

public RMPath getPath()

Returns the path for this polygon shape.

Overrides:

getPath in class RMShape

setPath

public void setPath(RMPath aPath)

Sets the path for this polygon shape.

superSelectable

public boolean superSelectable()

Editor method - indicates that this shape can be super selected.

Overrides:

superSelectable in class RMShape

paintShape

public void paintShape(RMShapePainter aPntr)

Handles painting a polygon shape.

Overrides:

paintShape in class RMShape

toXMLShape

protected RXElement toXMLShape(RXArchiver anArchiver)

XML archival.

Overrides:

toXMLShape in class RMParentShape

fromXMLShape

protected void fromXMLShape(RXArchiver anArchiver,
                            RXElement anElement)

XML unarchival.

Overrides:

fromXMLShape in class RMParentShape

clone

public RMPolygonShape clone()

Standard clone implementation.

Overrides:

clone in class RMParentShape

getPathTransform

public RMTransform getPathTransform()

Returns the matrix which transforms from path space to this shape's space (path space is arbitrarily defined, and always gets scaled to fit exactly into getBoundsInside()).

resetPath

public void resetPath(RMPath newPath)

Replace the polygon's current path with a new path, adjusting the shape's bounds to match the new path.