Class/Object

com.kodekutters.czml.czmlProperties

CZMLPacket

Related Docs: object CZMLPacket | package czmlProperties

Permalink

case class CZMLPacket(id: Option[String] = None, name: Option[String] = None, parent: Option[String] = None, description: Option[Description] = None, version: Option[String] = None, delete: Option[Boolean] = None, properties: HashSet[CzmlProperty] = HashSet.empty) extends Packet with Product with Serializable

A CZML packet describes the graphical properties for a single object in the scene, such as a single aircraft.

id

The ID of the object described by this packet. IDs do not need to be GUIDs, but they do need to uniquely identify a single object within a CZML source and any other CZML sources loaded into the same scope. If this property is not specified, the client will automatically generate a unique one. However, this prevents later packets from referring to this object in order to, for example, add more data to it.

name

The name of the object. It does not have to be unique and is intended for user consumption.

parent

The ID of the parent object or folder.

description

An HTML description of the object.

version

The CZML version being written. Only valid on the document object.

delete

Whether the client should delete all existing data for this object, identified by ID. If true, all other properties in this packet will be ignored.

properties

The set of properties of this object

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

Instance Constructors

  1. new CZMLPacket(packet: CZMLPacket)

    Permalink
  2. new CZMLPacket(id: String, properties: HashSet[CzmlProperty])

    Permalink
  3. new CZMLPacket(id: String, name: String, description: String, properties: HashSet[CzmlProperty])

    Permalink
  4. new CZMLPacket(id: String, name: String, properties: HashSet[CzmlProperty])

    Permalink
  5. new CZMLPacket(id: String, name: String, parent: String, description: String, version: String, properties: HashSet[CzmlProperty])

    Permalink
  6. new CZMLPacket(id: String, version: String)

    Permalink
  7. new CZMLPacket(id: Option[String] = None, name: Option[String] = None, parent: Option[String] = None, description: Option[Description] = None, version: Option[String] = None, delete: Option[Boolean] = None, properties: HashSet[CzmlProperty] = HashSet.empty)

    Permalink

    id

    The ID of the object described by this packet. IDs do not need to be GUIDs, but they do need to uniquely identify a single object within a CZML source and any other CZML sources loaded into the same scope. If this property is not specified, the client will automatically generate a unique one. However, this prevents later packets from referring to this object in order to, for example, add more data to it.

    name

    The name of the object. It does not have to be unique and is intended for user consumption.

    parent

    The ID of the parent object or folder.

    description

    An HTML description of the object.

    version

    The CZML version being written. Only valid on the document object.

    delete

    Whether the client should delete all existing data for this object, identified by ID. If true, all other properties in this packet will be ignored.

    properties

    The set of properties of this object

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. def asEventSourceData(): String

    Permalink

    returns an eventSource data representation of this packet

    returns an eventSource data representation of this packet

    Definition Classes
    CZMLPacketPacket
  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 delete: Option[Boolean]

    Permalink

    Whether the client should delete all existing data for this object, identified by ID.

    Whether the client should delete all existing data for this object, identified by ID. If true, all other properties in this packet will be ignored.

  8. val description: Option[Description]

    Permalink

    An HTML description of the object.

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

    Permalink
    Definition Classes
    AnyRef
  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 id: Option[String]

    Permalink

    The ID of the object described by this packet.

    The ID of the object described by this packet. IDs do not need to be GUIDs, but they do need to uniquely identify a single object within a CZML source and any other CZML sources loaded into the same scope. If this property is not specified, the client will automatically generate a unique one. However, this prevents later packets from referring to this object in order to, for example, add more data to it.

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. val name: Option[String]

    Permalink

    The name of the object.

    The name of the object. It does not have to be unique and is intended for user consumption.

  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 parent: Option[String]

    Permalink

    The ID of the parent object or folder.

  19. val properties: HashSet[CzmlProperty]

    Permalink

    The set of properties of this object

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

    Permalink
    Definition Classes
    AnyRef
  21. val version: Option[String]

    Permalink

    The CZML version being written.

    The CZML version being written. Only valid on the document object.

  22. final def wait(): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. 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 Packet

Inherited from AnyRef

Inherited from Any

Ungrouped