Class/Object

com.kodekutters.czml.czmlProperties

Billboard

Related Docs: object Billboard | package czmlProperties

Permalink

case class Billboard(color: Option[ColorProperty] = None, eyeOffset: Option[CzmlCartesian] = None, horizontalOrigin: Option[Origin[HORIZONTAL]] = None, image: Option[ImageUri] = None, pixelOffset: Option[CzmlCartesian2] = None, scale: Option[Number] = None, rotation: Option[Number] = None, alignedAxis: Option[CzmlCartesian] = None, show: Option[CzmlBoolean] = None, verticalOrigin: Option[Origin[VERTICAL]] = None) extends CzmlProperty with Product with Serializable

A billboard, or viewport-aligned image. The billboard is positioned in the scene by the position property. A billboard is sometimes called a marker.

color

This color value is multiplied with the values of the billboard's "image" to produce the final color.

eyeOffset

The eye offset of the billboard, which is the offset in eye coordinates at which to place the billboard relative to the position property. Eye coordinates are a left-handed coordinate system where the X-axis points toward the viewer's right, the Y-axis points up, and the Z-axis points into the screen.

horizontalOrigin

The horizontal origin of the billboard. It controls whether the billboard image is left-, center-, or right-aligned with the position.

image

The image displayed on the billboard, expressed as a URL. For broadest client compatibility, the URL should be accessible via Cross-Origin Resource Sharing (CORS). The URL may also be a data URI.

pixelOffset

The offset, in viewport pixels, of the billboard origin from the position. A pixel offset is the number of pixels up and to the right to place the billboard, relative to the position.

scale

The scale of the billboard. The scale is multiplied with the pixel size of the billboard's image. For example, if the scale is 2.0, the billboard will be rendered with twice the number of pixels, in each direction, of the image.

rotation

The rotation of the billboard offset from the alignedAxes.

alignedAxis

The aligned axis is the unit vector, in world coordinates, that the billboard up vector points towards. The default is the zero vector, which means the billboard is aligned to the screen up vector.

show

whether or not to show this property

verticalOrigin

The vertical origin of the billboard. It controls whether the billboard image is bottom-, center-, or top-aligned with the position.

Linear Supertypes
Serializable, Serializable, Product, Equals, CzmlProperty, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Billboard
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. CzmlProperty
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Billboard(color: Option[ColorProperty] = None, eyeOffset: Option[CzmlCartesian] = None, horizontalOrigin: Option[Origin[HORIZONTAL]] = None, image: Option[ImageUri] = None, pixelOffset: Option[CzmlCartesian2] = None, scale: Option[Number] = None, rotation: Option[Number] = None, alignedAxis: Option[CzmlCartesian] = None, show: Option[CzmlBoolean] = None, verticalOrigin: Option[Origin[VERTICAL]] = None)

    Permalink

    color

    This color value is multiplied with the values of the billboard's "image" to produce the final color.

    eyeOffset

    The eye offset of the billboard, which is the offset in eye coordinates at which to place the billboard relative to the position property. Eye coordinates are a left-handed coordinate system where the X-axis points toward the viewer's right, the Y-axis points up, and the Z-axis points into the screen.

    horizontalOrigin

    The horizontal origin of the billboard. It controls whether the billboard image is left-, center-, or right-aligned with the position.

    image

    The image displayed on the billboard, expressed as a URL. For broadest client compatibility, the URL should be accessible via Cross-Origin Resource Sharing (CORS). The URL may also be a data URI.

    pixelOffset

    The offset, in viewport pixels, of the billboard origin from the position. A pixel offset is the number of pixels up and to the right to place the billboard, relative to the position.

    scale

    The scale of the billboard. The scale is multiplied with the pixel size of the billboard's image. For example, if the scale is 2.0, the billboard will be rendered with twice the number of pixels, in each direction, of the image.

    rotation

    The rotation of the billboard offset from the alignedAxes.

    alignedAxis

    The aligned axis is the unit vector, in world coordinates, that the billboard up vector points towards. The default is the zero vector, which means the billboard is aligned to the screen up vector.

    show

    whether or not to show this property

    verticalOrigin

    The vertical origin of the billboard. It controls whether the billboard image is bottom-, center-, or top-aligned with the position.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val alignedAxis: Option[CzmlCartesian]

    Permalink

    The aligned axis is the unit vector, in world coordinates, that the billboard up vector points towards.

    The aligned axis is the unit vector, in world coordinates, that the billboard up vector points towards. The default is the zero vector, which means the billboard is aligned to the screen up vector.

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. val color: Option[ColorProperty]

    Permalink

    This color value is multiplied with the values of the billboard's "image" to produce the final color.

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. val eyeOffset: Option[CzmlCartesian]

    Permalink

    The eye offset of the billboard, which is the offset in eye coordinates at which to place the billboard relative to the position property.

    The eye offset of the billboard, which is the offset in eye coordinates at which to place the billboard relative to the position property. Eye coordinates are a left-handed coordinate system where the X-axis points toward the viewer's right, the Y-axis points up, and the Z-axis points into the screen.

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. val horizontalOrigin: Option[Origin[HORIZONTAL]]

    Permalink

    The horizontal origin of the billboard.

    The horizontal origin of the billboard. It controls whether the billboard image is left-, center-, or right-aligned with the position.

  13. val image: Option[ImageUri]

    Permalink

    The image displayed on the billboard, expressed as a URL.

    The image displayed on the billboard, expressed as a URL. For broadest client compatibility, the URL should be accessible via Cross-Origin Resource Sharing (CORS). The URL may also be a data URI.

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. val pixelOffset: Option[CzmlCartesian2]

    Permalink

    The offset, in viewport pixels, of the billboard origin from the position.

    The offset, in viewport pixels, of the billboard origin from the position. A pixel offset is the number of pixels up and to the right to place the billboard, relative to the position.

  19. val rotation: Option[Number]

    Permalink

    The rotation of the billboard offset from the alignedAxes.

  20. val scale: Option[Number]

    Permalink

    The scale of the billboard.

    The scale of the billboard. The scale is multiplied with the pixel size of the billboard's image. For example, if the scale is 2.0, the billboard will be rendered with twice the number of pixels, in each direction, of the image.

  21. val show: Option[CzmlBoolean]

    Permalink

    whether or not to show this property

  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. val verticalOrigin: Option[Origin[VERTICAL]]

    Permalink

    The vertical origin of the billboard.

    The vertical origin of the billboard. It controls whether the billboard image is bottom-, center-, or top-aligned with the position.

  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CzmlProperty

Inherited from AnyRef

Inherited from Any

Ungrouped