TLspFillStyle (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.view.lightspeed.style.ALspStyle
- - com.luciad.view.lightspeed.style.TLspFillStyle

All Implemented Interfaces:

ILspEffectsHintStyle, ILspTexturedStyle, ILspWorldElevationStyle, ILspStyler
```
public class TLspFillStyle
extends ALspStyle
implements ILspTexturedStyle, ILspWorldElevationStyle, ILspEffectsHintStyle
```
Style that defines a shape's fill. A fill can be one of the following:
- Solid color fills
- Colored stipple patterns (e.g. hatching)
- Textures: an image, icon or texture object is used to fill the geometry.
These options can be combined, so you can for instance apply a color to a texture, in which case the colors in the image are multiplied by the color of the style.
Construction of a fill style is done through the Builder design pattern mechanism.
Since:

2012.0

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TLspFillStyle.Builder<B extends TLspFillStyle.Builder<B>>` Builder used to create fill styles.
`static class`	`TLspFillStyle.StipplePattern` Represents a 2D stipple pattern, which is specified by a 32x32 grid of bits.

Nested classes/interfaces inherited from interface com.luciad.view.lightspeed.style.ILspTexturedStyle
ILspTexturedStyle.TextureCoordinatesMode

Nested classes/interfaces inherited from interface com.luciad.view.lightspeed.style.ILspWorldElevationStyle
ILspWorldElevationStyle.ElevationMode

Nested classes/interfaces inherited from interface com.luciad.view.lightspeed.style.ILspEffectsHintStyle
ILspEffectsHintStyle.EffectsHint

Constructor Summary

Constructors
Modifier Constructor and Description

protected TLspFillStyle(TLspFillStyle.Builder<?> aBuilder)
Creates a new style with the properties that are set on the builder

Constructors
Modifier	Constructor and Description
`protected`	`TLspFillStyle(TLspFillStyle.Builder<?> aBuilder)` Creates a new style with the properties that are set on the builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TLspFillStyle.Builder<?>`	`asBuilder()` Creates a new builder initialized with all the properties of this style.
`boolean`	`equals(Object obj)`
`Color`	`getColor()` Gets the color.
`Collection<ILspEffectsHintStyle.EffectsHint>`	`getEffectsHints()` Returns the effects hints specified for this style.
`ILspWorldElevationStyle.ElevationMode`	`getElevationMode()` Returns the elevation mode of this style.
`TLspFillStyle.StipplePattern`	`getStipplePattern()` Gets the stipple pattern used for the fill.
`RenderedImage`	`getTexture()` Gets the texture used for the fill.
`ILspTexturedStyle.TextureCoordinatesMode`	`getTextureCoordinatesMode()` Specifies whether the texture coordinates computed to apply the texture map should be relative to the bounds of the object or relative to the world.
`ILcdIcon`	`getTextureIcon()` Returns the texture icon used for the fill, if any.
`ELcdInterpolationType`	`getTextureInterpolationType()` Specifies whether linear filtering should be used for the texture map.
`void`	`getTextureMatrixSFCT(double[] aMatrixSFCT)` Returns a 4x4 matrix that should be applied to the texture coordinates when mapping the texture given by this style.
`ALsp2DTextureObject`	`getTextureObject()` Returns the texture object to be used.
`int`	`hashCode()`
`boolean`	`isRepeatTexture()` Returns true if the texture should be repeated (or tiled).
`boolean`	`isTransparent()` Determines whether this style is transparent.
`static TLspFillStyle.Builder<?>`	`newBuilder()` Creates a new builder with the default values.
`String`	`toString()`

Methods inherited from class com.luciad.view.lightspeed.style.ALspStyle
addStyleChangeListener, getZOrder, isCompatible, removeStyleChangeListener, style

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TLspFillStyle
```
protected TLspFillStyle(TLspFillStyle.Builder<?> aBuilder)
```
    Creates a new style with the properties that are set on the builder
    
    Parameters:
    
    aBuilder - a builder which will be used to initialize this style.
- Method Detail
  - newBuilder
```
public static TLspFillStyle.Builder<?> newBuilder()
```
    Creates a new builder with the default values.
    
    Returns:
    
    the new builder.
  - asBuilder
```
public TLspFillStyle.Builder<?> asBuilder()
```
    Creates a new builder initialized with all the properties of this style.
    
    Specified by:
    
    asBuilder in class ALspStyle
    
    Returns:
    
    the new builder.
  - getColor
```
public Color getColor()
```
    Gets the color.
    
    Returns:
    
    the color
  - isTransparent
```
public boolean isTransparent()
```
    Description copied from class: ALspStyle
    
    Determines whether this style is transparent.
    Shapes that are transparent can be painted in a different paint phase than shapes that are not transparent.
    
    Specified by:
    
    isTransparent in class ALspStyle
    
    Returns:
    
    whether or not this style is transparent
  - getTexture
```
public RenderedImage getTexture()
```
    Gets the texture used for the fill. Can be null.
    
    Specified by:
    
    getTexture in interface ILspTexturedStyle
    
    Returns:
    
    the texture used for the fill, can be null.
  - getTextureObject
```
public ALsp2DTextureObject getTextureObject()
```
    Description copied from interface: ILspTexturedStyle
    
    Returns the texture object to be used.
    
    Specified by:
    
    getTextureObject in interface ILspTexturedStyle
    
    Returns:
    
    the texture object
  - getTextureIcon
```
public ILcdIcon getTextureIcon()
```
    Returns the texture icon used for the fill, if any. Usually a texture icon is preferred over a RenderedImage because it has better results when printing at high resolutions.
    
    Returns:
    
    the texture icon used for the fill, or null
  - isRepeatTexture
```
public boolean isRepeatTexture()
```
    Returns true if the texture should be repeated (or tiled). If false, texture coordinates outside the [0, 1] range are clamped.
    
    Specified by:
    
    isRepeatTexture in interface ILspTexturedStyle
    
    Returns:
    
    true if the texture should be repeated (or tiled)
  - getTextureInterpolationType
```
public ELcdInterpolationType getTextureInterpolationType()
```
    Description copied from interface: ILspTexturedStyle
    
    Specifies whether linear filtering should be used for the texture map.
    
    Specified by:
    
    getTextureInterpolationType in interface ILspTexturedStyle
    
    Returns:
    
    whether linear texture filtering should be used
  - getTextureCoordinatesMode
```
public ILspTexturedStyle.TextureCoordinatesMode getTextureCoordinatesMode()
```
    Description copied from interface: ILspTexturedStyle
    
    Specifies whether the texture coordinates computed to apply the texture map should be relative to the bounds of the object or relative to the world. In the former case, the map is scaled and offset such that it fills the bounds (in model coordinates) of the object. In the latter case, the model coordinates of the object are used as texture coordinates unmodified.
    
    Specified by:
    
    getTextureCoordinatesMode in interface ILspTexturedStyle
    
    Returns:
    
    the mode indicating how the texture should be mapped on the object being styled
  - getTextureMatrixSFCT
```
public void getTextureMatrixSFCT(double[] aMatrixSFCT)
```
    Description copied from interface: ILspTexturedStyle
    
    Returns a 4x4 matrix that should be applied to the texture coordinates when mapping the texture given by this style. This can be used to scale, rotate or otherwise transform the texture.
    
    Specified by:
    
    getTextureMatrixSFCT in interface ILspTexturedStyle
    
    Parameters:
    
    aMatrixSFCT - array containing the elements of a 4x4 matrix in column-major order
  - getStipplePattern
```
public TLspFillStyle.StipplePattern getStipplePattern()
```
    Gets the stipple pattern used for the fill. Can be null.
    
    Returns:
    
    the stipple pattern used for the fill, can be null.
  - getElevationMode
```
public ILspWorldElevationStyle.ElevationMode getElevationMode()
```
    Description copied from interface: ILspWorldElevationStyle
    
    Returns the elevation mode of this style.
    
    Specified by:
    
    getElevationMode in interface ILspWorldElevationStyle
    
    Returns:
    
    The elevation mode.
  - getEffectsHints
```
public Collection<ILspEffectsHintStyle.EffectsHint> getEffectsHints()
```
    Description copied from interface: ILspEffectsHintStyle
    
    Returns the effects hints specified for this style.
    
    Specified by:
    
    getEffectsHints in interface ILspEffectsHintStyle
    
    Returns:
    
    the effects hints specified for this style
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class ALspStyle
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class ALspStyle
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

LuciadLightspeedClass TLspFillStyle

Nested Class Summary

Nested classes/interfaces inherited from interface com.luciad.view.lightspeed.style.ILspTexturedStyle

Nested classes/interfaces inherited from interface com.luciad.view.lightspeed.style.ILspWorldElevationStyle

Nested classes/interfaces inherited from interface com.luciad.view.lightspeed.style.ILspEffectsHintStyle

Constructor Summary

Method Summary

Methods inherited from class com.luciad.view.lightspeed.style.ALspStyle

Methods inherited from class java.lang.Object

Constructor Detail

TLspFillStyle

Method Detail

newBuilder

asBuilder

getColor

isTransparent

getTexture

getTextureObject

getTextureIcon

isRepeatTexture

getTextureInterpolationType

getTextureCoordinatesMode

getTextureMatrixSFCT

getStipplePattern

getElevationMode

getEffectsHints

hashCode

equals

toString