Package com.inductiveautomation.rm.shape
Class RMAnimPathShape
- java.lang.Object
- 
- All Implemented Interfaces:
- Archivable,- DeepChangeListener,- RMPropertyChanger,- RMTypes,- java.beans.PropertyChangeListener,- java.lang.Cloneable,- java.util.EventListener
 
 public class RMAnimPathShape extends RMPolygonShape A shape that can orient its children along a bezier path.By being an RMPolygon subclass, this class inherits all the path editing behavior of the polygon. Unlike the base polygon, however, this shape always has 1 or more children. The children shapes will be positioned and oriented at _distance along the path. 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classRMAnimPathShape.RMAnimPathGroupA shape subclass that adds the ability to be rotated about an arbitrary point.- 
Nested classes/interfaces inherited from interface com.inductiveautomation.rm.base.RMTypesRMTypes.Align, RMTypes.AlignX, RMTypes.AlignY
 
- 
 - 
Field Summary- 
Fields inherited from class com.inductiveautomation.rm.shape.RMShapeBINDING_PROP_NAME, STROKE_BORDER, STROKE_DOUBLE, STROKE_HIDDEN, STROKE_SHAPE
 
- 
 - 
Constructor SummaryConstructors Constructor Description RMAnimPathShape()Creates a new RMAnimPathShape.RMAnimPathShape(RMShape aShape)Creates an animpath shape from another shape.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddChild(RMShape aChild, int anIndex)Override add child to handle animated child shape specialRMAnimPathShapeclone()Standard clone implementation.booleancontains(RMPoint aPoint)Overridden to just reflect bounds of anim child.protected voidfromXMLShape(RXArchiver anArchiver, RXElement anElement)XML unarchival.RMShapegetAnimChild()Returns the animated child shape.RMRectgetBoundsMarked()Overridden to just reflect bounds of anim child.RMRectgetBoundsMarkedDeep()Overridden to just reflect bounds of anim child.intgetChildOrigin()Returns the child origin.floatgetDistance()Returns distance along the path where children are positioned.booleangetPreservesOrientation()Returns whether the children will have their rotation adjusted as they move along the path.RMLine[]getSegments()Builds the segment list and caches itfloatgetTotalLength()Returns the actual total arclength of the curve.voidpaintShape(RMShapePainter aPntr)Overridden to skip painting at preview time and to paint stroke (anim path) under child.voidpaintShapeOver(RMShapePainter aPntr)Overridden to skip painting stroke on top.voidpathChanged()Called by the tool when the path has been changed.voidpositionChildren()PositionChildrenvoidsetAnimChild(RMShape aChild)Sets the shape which will be positioned along the pathvoidsetChildOrigin(int aValue)Sets child origin.voidsetDistance(float aValue)Sets distance along path to position children.voidsetHeight(double aValue)Overridden to mark the path dirty.voidsetPath(RMPath aPath)Overridden to mark the path dirtyvoidsetPreservesOrientation(boolean aValue)Sets whether the children's rotation should get adjusted as they move along the path.voidsetWidth(double aValue)Overridden to mark the path dirty.protected RXElementtoXMLShape(RXArchiver anArchiver)XML archival.- 
Methods inherited from class com.inductiveautomation.rm.shape.RMPolygonShapegetPath, getPathTransform, resetPath, superSelectable
 - 
Methods inherited from class com.inductiveautomation.rm.shape.RMParentShapeaddChild, 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, setLayout, setNeedsLayout, setSourceURL, toXML, toXMLChildren
 - 
Methods inherited from class com.inductiveautomation.rm.shape.RMShapeacceptsChildren, acceptsMouse, addBinding, addBinding, addDeepChangeListener, addMouseListener, animUpdate, bounds, childrenSuperSelectImmediately, 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, 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, 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.RMObjectaddPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, getPCEvent, removePropertyChangeListener, sendPropertyChange
 - 
Methods inherited from class com.inductiveautomation.rm.base.RMListenerListaddListener, getListener, getListenerCount, getListenerCount, getListenerList, getListeners, hasListeners, removeListener
 
- 
 
- 
- 
- 
Constructor Detail- 
RMAnimPathShapepublic RMAnimPathShape() Creates a new RMAnimPathShape.
 - 
RMAnimPathShapepublic RMAnimPathShape(RMShape aShape) Creates an animpath shape from another shape.
 
- 
 - 
Method Detail- 
getAnimChildpublic RMShape getAnimChild() Returns the animated child shape.
 - 
setAnimChildpublic void setAnimChild(RMShape aChild) Sets the shape which will be positioned along the path
 - 
addChildpublic void addChild(RMShape aChild, int anIndex) Override add child to handle animated child shape special- Overrides:
- addChildin class- RMParentShape
 
 - 
getBoundsMarkedpublic RMRect getBoundsMarked() Overridden to just reflect bounds of anim child.- Overrides:
- getBoundsMarkedin class- RMShape
 
 - 
getBoundsMarkedDeeppublic RMRect getBoundsMarkedDeep() Overridden to just reflect bounds of anim child.- Overrides:
- getBoundsMarkedDeepin class- RMShape
 
 - 
containspublic boolean contains(RMPoint aPoint) Overridden to just reflect bounds of anim child.
 - 
clonepublic RMAnimPathShape clone() Standard clone implementation.- Overrides:
- clonein class- RMPolygonShape
 
 - 
paintShapepublic void paintShape(RMShapePainter aPntr) Overridden to skip painting at preview time and to paint stroke (anim path) under child.- Overrides:
- paintShapein class- RMPolygonShape
 
 - 
paintShapeOverpublic void paintShapeOver(RMShapePainter aPntr) Overridden to skip painting stroke on top.- Overrides:
- paintShapeOverin class- RMShape
 
 - 
getDistancepublic float getDistance() Returns distance along the path where children are positioned.- See Also:
- setDistance(float)
 
 - 
setDistancepublic void setDistance(float aValue) Sets distance along path to position children. Distance is in the range of [0-1] with 0 representing the start of the path and 1 the end.
 - 
getTotalLengthpublic float getTotalLength() Returns the actual total arclength of the curve. Used internally by the AnimPath to convert a distance of 0 through 1 to an actual point on the path.
 - 
getPreservesOrientationpublic boolean getPreservesOrientation() Returns whether the children will have their rotation adjusted as they move along the path.- See Also:
- setPreservesOrientation(boolean)
 
 - 
setPreservesOrientationpublic void setPreservesOrientation(boolean aValue) Sets whether the children's rotation should get adjusted as they move along the path. If flag is true, the original rotation of the shape is 'preserved' relative to the tangent to the path at the current point.
 - 
getChildOriginpublic int getChildOrigin() Returns the child origin.
 - 
setChildOriginpublic void setChildOrigin(int aValue) Sets child origin.
 - 
pathChangedpublic void pathChanged() Called by the tool when the path has been changed.
 - 
setWidthpublic void setWidth(double aValue) Overridden to mark the path dirty.- Overrides:
- setWidthin class- RMParentShape
 
 - 
setHeightpublic void setHeight(double aValue) Overridden to mark the path dirty.- Overrides:
- setHeightin class- RMParentShape
 
 - 
setPathpublic void setPath(RMPath aPath) Overridden to mark the path dirty- Overrides:
- setPathin class- RMPolygonShape
 
 - 
getSegmentspublic RMLine[] getSegments() Builds the segment list and caches it
 - 
positionChildrenpublic void positionChildren() PositionChildren
 - 
toXMLShapeprotected RXElement toXMLShape(RXArchiver anArchiver) XML archival.- Overrides:
- toXMLShapein class- RMPolygonShape
 
 - 
fromXMLShapeprotected void fromXMLShape(RXArchiver anArchiver, RXElement anElement) XML unarchival.- Overrides:
- fromXMLShapein class- RMPolygonShape
 
 
- 
 
-