Package gov.nasa.worldwind.render

Class BasicBalloonAttributes

    • Field Detail

      • size

        protected Size size
        Indicates the width and height of the balloon's shape in the viewport. Initially null.

      • maxSize

        protected Size maxSize
        Indicates the maximum width and height of the balloon's shape in the viewport. Initially null.

      • offset

        protected Offset offset
        Indicates the location at which the balloon's lower left corner is aligned. Initially null.

      • insets

        protected java.awt.Insets insets
        Indicates the padding between the balloon's content and its frame, in pixels. Initially null.

      • balloonShape

        protected java.lang.String balloonShape
        Indicates the shape of the balloon's frame. Initially null.

      • leaderShape

        protected java.lang.String leaderShape
        Indicates the shape of the balloon's leader. Initially null.

      • leaderWidth

        protected int leaderWidth
        Indicates the width of the balloon's leader, in pixels. Initially 0.

      • cornerRadius

        protected int cornerRadius
        Indicates the radius of each rounded corner on the balloon's rectangular frame, in pixels. Initially 0.

      • font

        protected java.awt.Font font
        Indicates the font used to display the balloon's text. Initially null.

      • textColor

        protected java.awt.Color textColor
        Indicates the color used to display the balloon's text. Initially null.

      • imageOffset

        protected java.awt.Point imageOffset
        Indicates the location of the image source in pixels. Initially null.

      • imageOpacity

        protected double imageOpacity
        Indicates the balloon texture's opacity as a floating-point value from 0.0 to 1.0. Initially 0.0.

      • imageRepeat

        protected java.lang.String imageRepeat
        Specifies the balloon texture's horizontal and vertical repeat mode. Initially null.

    • Constructor Detail

      • BasicBalloonAttributes

        public BasicBalloonAttributes()
        Creates a new BasicBalloonAttributes with the default attributes. The default attributes are as follows:
        Attributes
        AttributeDefault Value
        unresolvedtrue
        drawInteriortrue
        drawOutlinetrue
        enableAntialiasingtrue
        enableLightingfalse
        interiorMaterialMaterial.WHITE
        outlineMaterial171, 171, 171 (red, green, blue)
        interiorOpacity1.0
        outlineOpacity1.0
        outlineWidth1.0
        outlineStippleFactor0
        outlineStipplePattern0xF0F0
        interiorImageSourcenull
        interiorImageScale1.0
        size350x350 pixels (width x height)
        maximumSizenull
        offset40,60 pixels (x, y)
        insets30,15,15,15 (top, left, bottom, right)
        balloonShapeAVKey.SHAPE_RECTANGLE
        leaderShapeAVKey.SHAPE_TRIANGLE
        leaderWidth40.0
        cornerRadius20.0
        fontArial Plain 12
        textColorColor.BLACK
        imageOffset0,0 (x, y)
        imageOpacity1
        imageRepeatAVKey.REPEAT_XY

      • BasicBalloonAttributes

        public BasicBalloonAttributes​(BalloonAttributes attributes)
        Creates a new BasicBalloonAttributes configured with the specified attributes.
        Parameters:
        attributes - the attributes to configure the new BasicBalloonAttributes with.
        Throws:
        java.lang.IllegalArgumentException - if attributes is null.

    • Method Detail

      • copy

        public ShapeAttributes copy()
        Returns a new ShapeAttributes instance of the same type as this ShapeAttributes who's properties are configured exactly as this ShapeAttributes.

        Overrides the superclass' behavior to return a new BasicBalloonAttributes.

        Specified by:
        copy in interface ShapeAttributes
        Overrides:
        copy in class BasicShapeAttributes
        Returns:
        a copy of this ShapeAttributes.

      • copy

        public void copy​(ShapeAttributes attributes)
        Copies the specified ShapeAttributes' properties into this object's properties. This does nothing if the specified attributes is null.

        Extends the superclass' behavior to copy BalloonAttributes if the specified attributes is an instance of BalloonAttributes.

        Specified by:
        copy in interface ShapeAttributes
        Overrides:
        copy in class BasicShapeAttributes
        Parameters:
        attributes - the attributes to copy.

      • getSize

        public Size getSize()
        Indicates the width and height of the balloon's shape in the viewport. If the balloon's shape is AVKey.SHAPE_RECTANGLE, then the returned Size indicates the rectangle's width and height. If the balloon's shape is AVKey.SHAPE_ELLIPSE, then the returned Size indicates the ellipse's x- and y-radii.
        Specified by:
        getSize in interface BalloonAttributes
        Returns:
        the width and height of the balloon's shape in the viewport

      • setSize

        public void setSize​(Size size)
        Specifies the width and height of the balloon's shape in the viewport. If the balloon's shape is AVKey.SHAPE_RECTANGLE, then size specifies the rectangle's width and height. If the balloon's shape is AVKey.SHAPE_ELLIPSE, then size specifies the ellipse's x- and y-radii.

        The balloon's content area is the rectangle obtained by taking the balloon's size and shrinking it by the balloon's insets.

        Specified by:
        setSize in interface BalloonAttributes
        Parameters:
        size - the desired width and height of the balloon's shape in the viewport.
        See Also:
        BalloonAttributes.getSize(), BalloonAttributes.getMaximumSize(), BalloonAttributes.setInsets(java.awt.Insets)

      • getMaximumSize

        public Size getMaximumSize()
        Indicates the maximum width and height of the balloon's shape in the viewport. If the balloon's shape is AVKey.SHAPE_RECTANGLE, then the returned Size indicates the rectangle's maximum width and height. If the balloon's shape is AVKey.SHAPE_ELLIPSE, then the returned Size indicates the ellipse's maximum x- and y-radii. This returns null if the balloon has no maximum size.
        Specified by:
        getMaximumSize in interface BalloonAttributes
        Returns:
        the maximum width and height of the balloon's shape in the viewport, or null if the balloon has no maximum size.

      • setMaximumSize

        public void setMaximumSize​(Size maxSize)
        Specifies the maximum width and height of the balloon's shape in the viewport. If the balloon's shape is AVKey.SHAPE_RECTANGLE, then size specifies the rectangle's maximum width and height. If the balloon's shape is AVKey.SHAPE_ELLIPSE, then size specifies the ellipse's maximum x- and y-radii. Specifying a null size causes the balloon to have no maximum size.
        Specified by:
        setMaximumSize in interface BalloonAttributes
        Parameters:
        maxSize - the desired maximum width and height of the balloon's shape in the viewport, or null if the balloon should have no maximum size.

      • getLeaderWidth

        public int getLeaderWidth()
        Indicates the width of the balloon's leader, in pixels. The returned value is either zero or a positive integer.
        Specified by:
        getLeaderWidth in interface BalloonAttributes
        Returns:
        the width of the balloon's leader (in pixels) where it intersects the balloon's frame.
        See Also:
        BalloonAttributes.setLeaderWidth(int)

      • setLeaderWidth

        public void setLeaderWidth​(int width)
        Specifies the width of the balloon's leader, in pixels. The specified width must be zero or a positive integer. Specifying a width of zero disables the balloon's leader.

        This does nothing if the balloon's leader shape is AVKey.SHAPE_NONE.

        If the balloon's leader shape is AVKey.SHAPE_TRIANGLE, this specifies the size of the leader where it intersects the balloon's frame.

        Specified by:
        setLeaderWidth in interface BalloonAttributes
        Parameters:
        width - the desired leader width, in pixels.
        See Also:
        BalloonAttributes.getLeaderWidth()

      • getCornerRadius

        public int getCornerRadius()
        Indicates the radius of each rounded corner on the balloon's rectangular frame, in pixels. The returned value is either zero or a positive integer. If the returned value is zero the balloon's rectangular frame has sharp corners. This value is ignored if the balloon's shape is AVKey.SHAPE_ELLIPSE.
        Specified by:
        getCornerRadius in interface BalloonAttributes
        Returns:
        the radius of the rounded corner's on the balloon's on the balloon's rectangular frame, in pixels.
        See Also:
        BalloonAttributes.setCornerRadius(int)

      • setCornerRadius

        public void setCornerRadius​(int radius)
        Specifies the radius of the rounded corner's on the balloon's rectangular frame in pixels. The specified radius must be zero or a positive integer. Specifying a radius of zero causes the shape's rectangular frame to have sharp corners. This does nothing if the balloon's shape is AVKey.SHAPE_ELLIPSE.
        Specified by:
        setCornerRadius in interface BalloonAttributes
        Parameters:
        radius - the desired radius, in pixels.
        See Also:
        BalloonAttributes.getCornerRadius()

      • getOffset

        public Offset getOffset()
        Indicates the location relative to the balloon's screen reference point at which the balloon's frame shape is aligned. The balloon's lower left corner begins at the returned offset.
        Specified by:
        getOffset in interface BalloonAttributes
        Returns:
        the location at which the balloon's lower left corner is aligned.
        See Also:
        BalloonAttributes.setOffset(Offset)

      • setOffset

        public void setOffset​(Offset offset)
        Specifies a location relative to the balloon's screen reference point at which to align the balloon's frame shape. The balloon's frame shape begins at the point indicated by the offset. An offset of (0, 0) pixels causes the balloon's lower left corner to be placed at the screen reference point. An offset of (1, 1) in fraction units causes the balloon's upper right corner to be placed at the screen reference point.

        If the balloon is attached to the globe, the screen reference point is the projection of its geographic position into the viewport. If the balloon is attached to the screen, the screen reference point is the balloon's screen point.

        If the balloon has a leader shape, the leader extends from one side of the balloon's frame and points to the screen reference point.

        Specified by:
        setOffset in interface BalloonAttributes
        Parameters:
        offset - a location at which to align the balloon's lower left corner.
        See Also:
        BalloonAttributes.getOffset()

      • getInsets

        public java.awt.Insets getInsets()
        Indicates the amount of space between the balloon's content and its frame, in pixels. The balloon's content area decreases to account for the returned space.
        Specified by:
        getInsets in interface BalloonAttributes
        Returns:
        the padding between the balloon's content and its frame, in pixels.
        See Also:
        BalloonAttributes.setInsets(java.awt.Insets)

      • setInsets

        public void setInsets​(java.awt.Insets insets)
        Specifies the amount of space (in pixels) between the balloon's content and the edges of the balloon's frame. The balloon's content area decreases to account for the specified insets. If the balloon's size and insets cause the content width or height to become less than 1, then the balloon's content is not displayed.

        If the balloon's shape is AVKey.SHAPE_RECTANGLE, insets specifies the padding between the balloon's content area and the rectangle's top, left, bottom, and right.

        If the balloon's shape is AVKey.SHAPE_ELLIPSE, insets specifies the padding between the balloon's content area and the ellipse's top, left, bottom, and right apexes.

        Specified by:
        setInsets in interface BalloonAttributes
        Parameters:
        insets - the desired padding between the balloon's content and its frame, in pixels.
        See Also:
        BalloonAttributes.getInsets()

      • setFont

        public void setFont​(java.awt.Font font)
        Specifies the font in which to display the balloon's text. The specified font may be ignored if the balloon's text contains HTML.
        Specified by:
        setFont in interface BalloonAttributes
        Parameters:
        font - the font to use for the balloon's text.
        See Also:
        BalloonAttributes.getFont()

      • setTextColor

        public void setTextColor​(java.awt.Color color)
        Specifies the color in which to display the balloon's text. The specified color may be ignored if the balloon's text contains HTML.
        Specified by:
        setTextColor in interface BalloonAttributes
        Parameters:
        color - the color to use for the balloon's text.
        See Also:
        BalloonAttributes.getTextColor()

      • setImageOffset

        public void setImageOffset​(java.awt.Point offset)
        Specifies the location of the balloon's texture (in pixels) relative to the balloon's upper left corner. The location is applied to the balloon's texture before the balloon's texture scale is applied.
        Specified by:
        setImageOffset in interface BalloonAttributes
        Parameters:
        offset - the location of the balloon's texture source in pixels.
        See Also:
        BalloonAttributes.getImageOffset()

      • setImageOpacity

        public void setImageOpacity​(double opacity)
        Specifies the opacity of the balloon's texture as a floating-point value in the range 0.0 to 1.0. The specified opacity is multiplied by the shape's interior opacity to determine the texture's final opacity. A value of 1.0 specifies a completely opaque texture, and 0.0 specifies a completely transparent texture. Values in between specify a partially transparent texture.
        Specified by:
        setImageOpacity in interface BalloonAttributes
        Parameters:
        opacity - the balloon texture's opacity as a floating-point value from 0.0 to 1.0.
        See Also:
        BalloonAttributes.getImageOpacity()

      • setImageRepeat

        public void setImageRepeat​(java.lang.String repeat)
        Specifies the balloon texture's horizontal and vertical repeat mode. The repeat may be one of the following:

        If repeat is AVKey.REPEAT_NONE, the balloon's texture is displayed according to its offset and scale without any repeating pattern.

        If repeat is AVKey.REPEAT_X, AVKey.REPEAT_Y, or AVKey.REPEAT_XY, the balloon's texture is repeated along the X axis, along the Y axis, or along both the X and Y axes, respectively. The texture is repeated after its offset and scale are applied.

        Specified by:
        setImageRepeat in interface BalloonAttributes
        Parameters:
        repeat - the texture's repeat mode to use, one of AVKey.REPEAT_NONE, AVKey.REPEAT_X, AVKey.REPEAT_Y, or AVKey.REPEAT_XY.
        See Also:
        BalloonAttributes.getImageRepeat()

      • restoreState

        public void restoreState​(RestorableSupport restorableSupport,
                         RestorableSupport.StateObject context)
        Restores the state of any attributes contained in the specified RestorableSupport. If the StateObject is not null it's searched for attribute state values, otherwise the RestorableSupport root is searched.
        Specified by:
        restoreState in interface ShapeAttributes
        Overrides:
        restoreState in class BasicShapeAttributes
        Parameters:
        restorableSupport - the RestorableSupport that contains the attributes' state.
        context - the StateObject to search for state values, if not null.