Package ptolemy.domains.gr.lib

Class ViewScreen3D

    • Field Detail

      • sceneGraphIn

        public TypedIOPort sceneGraphIn
        The input scene graph. Actors that produce 3D objects can be connected to this port for rendering. The type of this port is sceneGraph.

      • backgroundColor

        public ColorAttribute backgroundColor
        The background color. Note that the alpha value (the fourth element of the array), which would normally specify transparency, is ignored.

      • horizontalResolution

        public Parameter horizontalResolution
        The width in pixels of the display screen. The larger of the vertical or horizontal size will correspond by default to one unit of distance, so this parameter determines the horizontal resolution as well as the size of the display. This is an int with default 400.

      • iterationSynchronized

        public Parameter iterationSynchronized
        Boolean variable that determines whether screen update is done once per iteration. This is a boolean with default false.

      • rotatable

        public Parameter rotatable
        Boolean variable that determines whether the user can rotate the model with the mouse. This is a boolean with default true.

      • scalable

        public Parameter scalable
        Boolean variable that determines whether the user can move the point of view along the z axis using the mouse. This is a boolean with default false.

      • showAxes

        public Parameter showAxes
        Boolean variable that determines whether or not axes are shown. This parameter is a boolean with default false.

      • title

        public StringParameter title
        The title to put at the top of the frame.

      • translatable

        public Parameter translatable
        Boolean variable that determines whether the user can translate the model with the mouse. This is a boolean with default false.

      • verticalResolution

        public Parameter verticalResolution
        The height in pixels of the display screen. The larger of the vertical or horizontal size will correspond by default to one unit of distance, so this parameter determines the horizontal resolution as well as the size of the display. This is an integer with default 400.

      • _bounds

        protected javax.media.j3d.BoundingSphere _bounds
        The BoundingSphere.

      • _branchRoot

        protected javax.media.j3d.BranchGroup _branchRoot
        The main connection branch that connects to the universe.

      • _root

        protected javax.media.j3d.BranchGroup _root
        The connection branch to which incoming nodes connect.

      • _canvas

        protected javax.media.j3d.Canvas3D _canvas
        The Java3D canvas component.

      • _container

        protected java.awt.Container _container
        The container set in the place() method, or the content pane of the created frame if place was not called.

      • _frame

        protected javax.swing.JFrame _frame
        The frame containing our canvas, if we created it.

      • _iterationSynchronized

        protected boolean _iterationSynchronized
        True for manual rendering, false for default rendering.

      • _lastTransform

        protected javax.media.j3d.Transform3D _lastTransform
        The last transform.

      • _mouseRotate

        protected ptolemy.domains.gr.lib.ViewScreen3D.MouseRotateView _mouseRotate
        The mouse rotate view.

      • _simpleUniverse

        protected com.sun.j3d.utils.universe.SimpleUniverse _simpleUniverse
        The Java3D universe, displayed inside the canvas.

      • _userTransformation

        protected javax.media.j3d.TransformGroup _userTransformation
        The user transformation.

    • Constructor Detail

      • ViewScreen3D

        public ViewScreen3D​(CompositeEntity container,
                    java.lang.String name)
             throws IllegalActionException,
                    NameDuplicationException
        Construct a ViewScreen in the given container with the given name. If the container argument is null, a NullPointerException will be thrown. If the name argument is null, then the name is set to the empty string. Increment the version number of the workspace.
        Parameters:
        container - Container of the director.
        name - Name of this ViewScreen.
        Throws:
        IllegalActionException - If this actor is not compatible with the specified container.
        NameDuplicationException - If the container not a CompositeActor and the name collides with an entity in the container.

    • Method Detail

      • addChild

        public void addChild​(javax.media.j3d.Node node)
        Add the node argument as a child to the encapsulated Java3D node in this actor.
        Parameters:
        node - The node to be added.

      • getBranchGroup

        public javax.media.j3d.BranchGroup getBranchGroup()
        Return the root Java 3D rendering group used by this view screen.
        Returns:
        the root Java 3D rendering group used by this view screen.

      • getCanvas

        public javax.media.j3d.Canvas3D getCanvas()
        Return the Java 3D canvas used by this view screen.
        Returns:
        the Java 3D canvas used by this view screen.

      • place

        public void place​(java.awt.Container container)
        Set the container that this actor should display data in. If place is not called, then the actor will create its own frame for display.
        Specified by:
        place in interface Placeable
        Parameters:
        container - The container in which to place the object, or null to specify that there is no current container.

      • postfire

        public boolean postfire()
                 throws IllegalActionException
        Description copied from class: AtomicActor
        Return true, unless stop() has been called, in which case, return false. Derived classes override this method to define operations to be performed at the end of every iteration of its execution, after one invocation of the prefire() method and any number of invocations of the fire() method. This method typically wraps up an iteration, which may involve updating local state. In derived classes, this method returns false to indicate that this actor should not be fired again.
        Specified by:
        postfire in interface Executable
        Overrides:
        postfire in class AtomicActor<TypedIOPort>
        Returns:
        True if execution can continue into the next iteration.
        Throws:
        IllegalActionException - Not thrown in this base class.

      • _addChild

        protected void _addChild​(javax.media.j3d.Node node)
        Add the node argument as a child to the encapsulated Java3D node in this actor.
        Overrides:
        _addChild in class GRActor3D
        Parameters:
        node - The node to add.

      • _createViewScreen

        protected void _createViewScreen()
                          throws IllegalActionException
        Create the view screen component. If place() was called with a container, then use the container. Otherwise, create a new frame and use that.
        Throws:
        IllegalActionException - If there is a problem reading a parameter.

      • _getHorizontalPixels

        protected int _getHorizontalPixels()
                            throws IllegalActionException
        Get the number of horizontal pixels in the rendered image.
        Returns:
        the number of horizontal pixels in the rendered image.
        Throws:
        IllegalActionException - If thrown while reading the horizontalPixels parameter.

      • _getNodeObject

        protected javax.media.j3d.Node _getNodeObject()
        The ViewScreen does not have an associated Java3D node.
        Specified by:
        _getNodeObject in class GRActor3D
        Returns:
        null

      • _getVerticalPixels

        protected int _getVerticalPixels()
                          throws IllegalActionException
        Get the number of vertical pixels in the rendered image.
        Returns:
        the number of vertical pixels in the rendered image.
        Throws:
        IllegalActionException - If thrown while reading the verticalPixels parameter.

      • _makeBackground

        protected javax.media.j3d.Background _makeBackground()
                                              throws IllegalActionException
        Makes the background for the viewScreen.
        Returns:
        javax.media.j3d.Background
        Throws:
        IllegalActionException - If unable to read the color parameter.

      • _makeNodeConnection

        protected void _makeNodeConnection()
                            throws IllegalActionException
        Connect each of the channels of the sceneGraphIn port to the scene.
        Throws:
        IllegalActionException - If thrown while reading from a channel.

      • _startRenderer

        protected void _startRenderer()
        Start the internal Java3D renderer.

      • _stopRenderer

        protected void _stopRenderer()
        Stop the internal Java3D renderer.