ConformalMap
vmm3d.conformalmap

Class ConformalMap

    • Field Detail

      • IDENTITY

        public static final int IDENTITY
        Code for the identity function as one of the possible functions that can be precomposed or postcomposed with a map.
        See Also:
        Constant Field Values
      • INVERSION

        public static final int INVERSION
        Code for the function 1/z as one of the possible functions that can be precomposed or postcomposed with a map.
        See Also:
        Constant Field Values
      • FRACTIONAL

        public static final int FRACTIONAL
        Code for the function (1-z)/(1+z) as one of the possible functions that can be precomposed or postcomposed with a map.
        See Also:
        Constant Field Values
      • SQRROOT

        public static final int SQRROOT
        Code for the square root function as one of the possible functions that can be precomposed or postcomposed with a map.
        See Also:
        Constant Field Values
      • CARTESIAN

        public static final int CARTESIAN
        Code for using a cartesian grid on the domain of the function.
        See Also:
        Constant Field Values
      • POLAR

        public static final int POLAR
        Code for using a polar grid on the domain of the function.
        See Also:
        Constant Field Values
      • POLARCONFORMAL

        public static final int POLARCONFORMAL
        Code for using a conformal polar grid on the domain of the function.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ConformalMap

        public ConformalMap()
    • Method Detail

      • getPostCompFunction

        public int getPostCompFunction()
        Gets the code number for the function that is postcomposed with the basic map.
        See Also:
        setPostCompFunction(int)
      • setPostCompFunction

        public void setPostCompFunction(int postCompFunction)
        Sets the function that is postcomposed with the basic map. The value should be one of the constants IDENTITY, INVERSION, FRACTIONAL, or SQRROOT. The default is IDENTITY. (This property is managed by an ActionRadioGroup, although it could also be set directly.)
      • getPreCompFunction

        public int getPreCompFunction()
        Gets the code number for the function that is precomposed with the basic map.
        See Also:
        setPreCompFunction(int)
      • setPreCompFunction

        public void setPreCompFunction(int preCompFunction)
        Sets the function that is precomposed with the basic map. The value should be one of the constants IDENTITY, INVERSION, FRACTIONAL, or SQRROOT. The default is IDENTITY. (This property is managed by an ActionRadioGroup, although it could also be set directly.)
      • getGridType

        public int getGridType()
        Gets the code number for the type of grid that is used on the domain of the function.
        See Also:
        setGridType(int)
      • setGridType

        public void setGridType(int gridType)
        Sets the type of grid that is used on the domain of the map. The value should be one of the constants CARTESIAN, POLAR, or POLARCONFORMAL; other values are ignored. The default is CARTESIAN. (This property is managed by an ActionRadioGroup, although it could also be set directly.) This method changes the values of umin, umax, vmin, vmax, ures, and vres to match the new grid type. Separate values for each grid type are stored for these parameters. When this method is used to change the grid type, the values of the paramters are set to the values saved for that grid type.
      • getDefaultWindow2D

        public double[] getDefaultWindow2D()
        Returns an array of four numbers representing the default 2D window.
        See Also:
        setDefaultWindow2D(double[])
      • setDefaultWindow2D

        public void setDefaultWindow2D(double[] defaultWindow2D)
        Sets the default 2D window for this exhibit. This is the window that is used when the view is in 2D mode, that is, when the domain is displayed or when the image is displayed in the complex plane. It is not used when the image is displayed on the Riemann Sphere.
        Parameters:
        defaultWindow2D - an array containing the default window, xmin, xmax, ymin, and ymax. If this parameter is null, nothing is done. If the array has fewer than four elements, an IllegalArgumentException is thrown.
      • setDefaultWindow2D

        public void setDefaultWindow2D(double xmin,                      double xmax,                      double ymin,                      double ymax)
        Sets the default 2D window for this exhibit. This is the window that is used when the view is in 2D mode, that is, when the domain is displayed or when the image is displayed in the complex plane. It is not used when the image is displayed on the Riemann Sphere. This convenience method just calls setDefaultWindow2D(double[]).
      • getCreateAnimation

        public Animation getCreateAnimation(View view)
        Returns an animation that shows the domain grid for a short time, then switches to the image. (However, no create animation is shown in "stereograph" views, since it would involve changing the window size back and forth.)
        Overrides:
        getCreateAnimation in class Exhibit
        Parameters:
        view - A View that is displaying this Exhibit. The animation, if any, that is returned by this method will be installed in the View's display. If the view is null, than a creation animation that can run independently of a view could be returned.
        Returns:
        A creation animation for the given View of this Exhibit. The return value can be null to indicate that no creation animation is to be run.
      • getDefaultView

        public View getDefaultView()
        Overridden to return a view of type ConformalMapView, defined by a nested class in this class.
        Overrides:
        getDefaultView in class Exhibit3D
      • getActionsForView

        public ActionList getActionsForView(View view)
        Description copied from class: Exhibit
        This method returns a list of ActionItem that can be applied to a View that contains this Exhibit. If the view parameter is null, it should return actions that are appropriate in any View. View is presumably one that is displaying this Exhibit.

        The items in the returned list must implement the ActionItem interface and generally belong to one of the classes AbstractActionVMM, ToggleAction, ActionRadioGroup, or ActionList. Null items represent separators.

        In this top-level Exhibit class, the return value is a list that contains one object of type AbstractActionVMM. The action represents the "Create" command, which is meant to run the "create animation" of the Exhibit.

        In general, when overriding this method, subclasses should call "super.getActionsForView()" to obtain a list of actions from the superclass. It can then add additional actions or remove or disable actions that are in the list from the superclass.

        Overrides:
        getActionsForView in class Exhibit
      • addExtraXML

        public void addExtraXML(Document containingDocument,               Element exhibitElement)
        Description copied from class: Exhibit
        This method is called when an XML representation of this exhibit is being constructed by the SaveAndRestore class to give the exhibit a chance to write any extra infomation that is not saved by default. Any Parameters associated with the exhibit are saved automatically. Note that Decorations associated with the exhibit are NOT saved automatically UNLESS the decoration class is marked with a VMMSave annotation. Property variables will also be saved automatically IF they are marked with VMMSave annotations.

        The method in this top level class does nothing.

        When a subclass overrides this method, it should ordinarily start by calling super.addExtraXML(containingDocument,exhibitElement) to make sure that information from the superclass is saved.

        Overrides:
        addExtraXML in class Exhibit
        Parameters:
        containingDocument - The overall XML document that contains the exhibit Element that is being created. This parameter is necessary because it is needed to create any nested subelements that are to be added to the exhibit element.
        exhibitElement - The XML element that is being constructed. This element already exists; the purpose of this method to add any extra information that would be needed to reconstruct this exhibit object from the XML represenation.
        See Also:
        Exhibit.readExtraXML(Element)

SCaVis 1.8 © jWork.org