RMScene3D (ignition 7.9.3 API)

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.RMScene3D

All Implemented Interfaces:

Archivable, DeepChangeListener, RMPropertyChanger, RMTypes, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener
```
public class RMScene3D
extends RMParentShape
```
This class manages a list of children and transforms them to 3D representations for display based on X and Y axis rotations. ReportMill 3D conventions: Coordinate system: Right handed (not left handed) Polygon front: Right hand rule (counter-clockwise defined polygons face forward) Transforms: Row major notation (as opposed to column major, points are assumed row vectors)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RMScene3D.RMShape3D
RMPolygon subclass that encapsulates a Path3D.
- Nested classes/interfaces inherited from interface com.inductiveautomation.rm.base.RMTypes
  RMTypes.Align, RMTypes.AlignX, RMTypes.AlignY

Nested Classes
Modifier and Type	Class and Description
`static class`	`RMScene3D.RMShape3D` RMPolygon subclass that encapsulates a Path3D.

Field Summary

Fields
Modifier and Type Field and Description

int CONSTRAIN_NONE

int CONSTRAIN_PITCH

int CONSTRAIN_YAW
- Fields inherited from class com.inductiveautomation.rm.shape.RMShape
  BINDING_PROP_NAME, STROKE_BORDER, STROKE_DOUBLE, STROKE_HIDDEN, STROKE_SHAPE

Fields
Modifier and Type	Field and Description
`int`	`CONSTRAIN_NONE`
`int`	`CONSTRAIN_PITCH`
`int`	`CONSTRAIN_YAW`

Constructor Summary

Constructors
Constructor and Description

RMScene3D()

Constructors
Constructor and Description
`RMScene3D()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptsMouse()` Viewer method.
`protected RMScene3D.RMShape3D`	`addChild3D(RMShape aShape, double z1, double z2, boolean fixEdges)` Adds a given shape in 3D.
`void`	`addShape(RMShape aShape)` Adds a shape to the end of the shape list.
`void`	`addShape(RMShape aShape, int anIndex)` Adds a shape to the shape list at the given index.
`void`	`copy3D(RMScene3D aScene3D)` Copy 3D attributes only.
`protected void`	`fromXMLShape(RXArchiver anArchiver, RXElement anElement)` XML unarchival.
`RMVector3D`	`getCamera()` Returns the camera as a vector.
`double`	`getDepth()` Returns the depth of the scene.
`double`	`getFieldOfView()` Returns the field of view of the camera (derived from focalLength).
`double`	`getFocalLength()` Returns the focal length of the camera (derived from the field of view and with view size).
`RMVector3D`	`getLight()` Returns the scene light as a vector.
`double`	`getOffsetZ()` Returns the Z offset of the scene (for zooming).
`RMPoint3D`	`getOrigin()` Returns the scene's origin.
`double`	`getPitch()` Returns the rotation about the X axis in degrees.
`double`	`getPseudoSkewX()` Returns the skew angle for X by Z.
`double`	`getPseudoSkewY()` Returns the skew angle for Y by Z.
`double`	`getRoll3D()` Returns the rotation about the Z axis in degrees.
`RMShape`	`getShape(int anIndex)` Returns the specific shape at the given index from the shape list.
`int`	`getShapeCount()` Returns the number of shapes in the shape list.
`RMTransform3D`	`getTransform3D()` Returns the transform 3d for the scene's camera.
`boolean`	`getValueIsAdjusting()` Returns whether scene3d is being re-oriented.
`double`	`getYaw()` Returns the rotation about the Y axis in degrees.
`boolean`	`isHittable(RMShape aChild)` Override to indicate that scene children are unhittable.
`boolean`	`isPseudo3D()` Returns whether scene is rendered in pseudo 3d.
`protected boolean`	`isShowing(RMShape aChild)` Override to make all 3D children show.
`protected void`	`layoutChildren()` Rebuilds 3D representation of shapes from shapes list.
`void`	`mouseDragged(RMShapeMouseEvent anEvent)` Viewer method.
`void`	`mousePressed(RMShapeMouseEvent anEvent)` Viewer method.
`void`	`mouseReleased(RMShapeMouseEvent anEvent)` Viewer method.
`void`	`removeShape(int anIndex)` Removes the shape at the given index from the shape list.
`void`	`resort()` Resorts child shapes from back to front.
`void`	`setColor(RMScene3D.RMShape3D aShape3D, RMColor aColor)` Sets the color for a 3d shape from a base color.
`void`	`setDefaultViewSettings()` Sets some reasonable default view settings.
`void`	`setDepth(double aValue)` Sets the depth of the scene.
`void`	`setFieldOfView(double aValue)` Sets the field of view of the camera.
`void`	`setFillAndStroke(RMScene3D.RMShape3D aShape3D, RMFill aFill, RMStroke aStroke, RMEffect anEffect)` Sets the fill and stroke of a 3D shape from a 2D shape.
`void`	`setFocalLength(double aValue)` Sets the focal length of the camera.
`void`	`setOffsetZ(double aValue)` Sets the Z offset of the scene (for zooming).
`void`	`setPitch(double aValue)` Sets the rotation about the X axis in degrees.
`void`	`setPseudo3D(boolean aFlag)` Sets whether scene is rendered in pseudo 3d.
`void`	`setPseudoSkewX(double anAngle)` Sets the skew angle for X by Z.
`void`	`setPseudoSkewY(double anAngle)` Sets the skew angle for Y by Z.
`void`	`setRoll3D(double aValue)` Sets the rotation about the Z axis in degrees.
`void`	`setYaw(double aValue)` Sets the rotation about the Y axis in degrees.
`protected void`	`toXMLChildren(RXArchiver anArchiver, RXElement anElement)` XML archival of children - overrides shape implementation to suppress archival of generated 3D shapes.
`protected RXElement`	`toXMLShape(RXArchiver anArchiver)` XML archival.

Methods inherited from class com.inductiveautomation.rm.shape.RMParentShape
addChild, addChild, addChild, addChild, addLayoutChild, bringShapesToFront, clone, cloneDeep, computePrefHeight, computePrefWidth, divideShapeFromTop, fromXML, fromXMLChildren, getBoundsOfChildren, getChild, getChildArray, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWithClass, getChildrenWithClass, getChildWithClass, getChildWithName, getLayout, getNeedsLayout, getSourceURL, indexOfChild, isSourceURLSet, layout, relayout, removeChild, removeChild, removeChildren, removeLayoutChild, rpgAll, rpgChildren, sendShapesToBack, setHeight, setLayout, setNeedsLayout, setSourceURL, setWidth, toXML

Methods inherited from class com.inductiveautomation.rm.shape.RMShape
acceptsChildren, 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, getPath, 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, mouseEntered, mouseExited, mouseMoved, offsetXY, page, pageMax, paint, paintShape, 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, superSelectable, 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

- Field Detail
  - CONSTRAIN_NONE
```
public final int CONSTRAIN_NONE
```
    See Also:
    
    Constant Field Values
  - CONSTRAIN_PITCH
```
public final int CONSTRAIN_PITCH
```
    See Also:
    
    Constant Field Values
  - CONSTRAIN_YAW
```
public final int CONSTRAIN_YAW
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RMScene3D
```
public RMScene3D()
```
- Method Detail
  - getDepth
```
public double getDepth()
```
    Returns the depth of the scene.
  - setDepth
```
public void setDepth(double aValue)
```
    Sets the depth of the scene.
  - getOrigin
```
public RMPoint3D getOrigin()
```
    Returns the scene's origin.
  - getYaw
```
public double getYaw()
```
    Returns the rotation about the Y axis in degrees.
  - setYaw
```
public void setYaw(double aValue)
```
    Sets the rotation about the Y axis in degrees.
  - getPitch
```
public double getPitch()
```
    Returns the rotation about the X axis in degrees.
  - setPitch
```
public void setPitch(double aValue)
```
    Sets the rotation about the X axis in degrees.
  - getRoll3D
```
public double getRoll3D()
```
    Returns the rotation about the Z axis in degrees.
  - setRoll3D
```
public void setRoll3D(double aValue)
```
    Sets the rotation about the Z axis in degrees.
  - getFocalLength
```
public double getFocalLength()
```
    Returns the focal length of the camera (derived from the field of view and with view size).
  - setFocalLength
```
public void setFocalLength(double aValue)
```
    Sets the focal length of the camera. Two feet is normal (1728 points).
  - getOffsetZ
```
public double getOffsetZ()
```
    Returns the Z offset of the scene (for zooming).
  - setOffsetZ
```
public void setOffsetZ(double aValue)
```
    Sets the Z offset of the scene (for zooming).
  - isPseudo3D
```
public boolean isPseudo3D()
```
    Returns whether scene is rendered in pseudo 3d.
  - setPseudo3D
```
public void setPseudo3D(boolean aFlag)
```
    Sets whether scene is rendered in pseudo 3d.
  - getPseudoSkewX
```
public double getPseudoSkewX()
```
    Returns the skew angle for X by Z.
  - setPseudoSkewX
```
public void setPseudoSkewX(double anAngle)
```
    Sets the skew angle for X by Z.
  - getPseudoSkewY
```
public double getPseudoSkewY()
```
    Returns the skew angle for Y by Z.
  - setPseudoSkewY
```
public void setPseudoSkewY(double anAngle)
```
    Sets the skew angle for Y by Z.
  - getFieldOfView
```
public double getFieldOfView()
```
    Returns the field of view of the camera (derived from focalLength).
  - setFieldOfView
```
public void setFieldOfView(double aValue)
```
    Sets the field of view of the camera.
  - setDefaultViewSettings
```
public void setDefaultViewSettings()
```
    Sets some reasonable default view settings.
  - getCamera
```
public RMVector3D getCamera()
```
    Returns the camera as a vector.
  - getLight
```
public RMVector3D getLight()
```
    Returns the scene light as a vector.
  - getShapeCount
```
public int getShapeCount()
```
    Returns the number of shapes in the shape list.
  - getShape
```
public RMShape getShape(int anIndex)
```
    Returns the specific shape at the given index from the shape list.
  - addShape
```
public void addShape(RMShape aShape)
```
    Adds a shape to the end of the shape list.
  - addShape
```
public void addShape(RMShape aShape,
                     int anIndex)
```
    Adds a shape to the shape list at the given index.
  - removeShape
```
public void removeShape(int anIndex)
```
    Removes the shape at the given index from the shape list.
  - getTransform3D
```
public RMTransform3D getTransform3D()
```
    Returns the transform 3d for the scene's camera.
  - layoutChildren
```
protected void layoutChildren()
```
    Rebuilds 3D representation of shapes from shapes list.
    
    Overrides:
    
    layoutChildren in class RMParentShape
  - addChild3D
```
protected RMScene3D.RMShape3D addChild3D(RMShape aShape,
                                         double z1,
                                         double z2,
                                         boolean fixEdges)
```
    Adds a given shape in 3D. FixEdges flag indicates wheter to stroke polygons created during extrusion, to try to make them mesh better. The axisAlign flag can be set to true to make sure the shape's coordinate system is aligned with the screen.
  - setFillAndStroke
```
public void setFillAndStroke(RMScene3D.RMShape3D aShape3D,
                             RMFill aFill,
                             RMStroke aStroke,
                             RMEffect anEffect)
```
    Sets the fill and stroke of a 3D shape from a 2D shape.
  - setColor
```
public void setColor(RMScene3D.RMShape3D aShape3D,
                     RMColor aColor)
```
    Sets the color for a 3d shape from a base color.
  - resort
```
public void resort()
```
    Resorts child shapes from back to front.
  - isShowing
```
protected boolean isShowing(RMShape aChild)
```
    Override to make all 3D children show.
    
    Overrides:
    
    isShowing in class RMParentShape
  - isHittable
```
public boolean isHittable(RMShape aChild)
```
    Override to indicate that scene children are unhittable.
    
    Overrides:
    
    isHittable in class RMParentShape
  - acceptsMouse
```
public boolean acceptsMouse()
```
    Viewer method.
    
    Overrides:
    
    acceptsMouse in class RMShape
  - mousePressed
```
public void mousePressed(RMShapeMouseEvent anEvent)
```
    Viewer method.
    
    Overrides:
    
    mousePressed in class RMShape
  - mouseDragged
```
public void mouseDragged(RMShapeMouseEvent anEvent)
```
    Viewer method.
    
    Overrides:
    
    mouseDragged in class RMShape
  - mouseReleased
```
public void mouseReleased(RMShapeMouseEvent anEvent)
```
    Viewer method.
    
    Overrides:
    
    mouseReleased in class RMShape
  - getValueIsAdjusting
```
public boolean getValueIsAdjusting()
```
    Returns whether scene3d is being re-oriented.
  - copy3D
```
public void copy3D(RMScene3D aScene3D)
```
    Copy 3D attributes only.
  - toXMLShape
```
protected RXElement toXMLShape(RXArchiver anArchiver)
```
    XML archival.
    
    Overrides:
    
    toXMLShape in class RMParentShape
  - toXMLChildren
```
protected void toXMLChildren(RXArchiver anArchiver,
                             RXElement anElement)
```
    XML archival of children - overrides shape implementation to suppress archival of generated 3D shapes.
    
    Overrides:
    
    toXMLChildren in class RMParentShape
  - fromXMLShape
```
protected void fromXMLShape(RXArchiver anArchiver,
                            RXElement anElement)
```
    XML unarchival.
    
    Overrides:
    
    fromXMLShape in class RMParentShape

Class RMScene3D

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Field Detail

CONSTRAIN_NONE

CONSTRAIN_PITCH

CONSTRAIN_YAW

Constructor Detail

RMScene3D

Method Detail

getDepth

setDepth

getOrigin

getYaw

setYaw

getPitch

setPitch

getRoll3D

setRoll3D

getFocalLength

setFocalLength

getOffsetZ

setOffsetZ

isPseudo3D

setPseudo3D

getPseudoSkewX

setPseudoSkewX

getPseudoSkewY

setPseudoSkewY

getFieldOfView

setFieldOfView

setDefaultViewSettings

getCamera

getLight

getShapeCount

getShape

addShape

addShape

removeShape

getTransform3D

layoutChildren

addChild3D

setFillAndStroke

setColor

resort

isShowing

isHittable

acceptsMouse

mousePressed

mouseDragged

mouseReleased

getValueIsAdjusting

copy3D

toXMLShape

toXMLChildren

fromXMLShape