C# Class CesiumLanguageWriter.PacketCesiumWriter

Writes a Packet to a CesiumOutputStream. A Packet describes the graphical properties of a single object in a scene, such as a single aircraft.
Inheritance: CesiumElementWriter
Show file Open project: AnalyticalGraphicsInc/czml-writer Class Usage Examples

Public Methods

Method Description
OpenBillboardProperty ( ) : BillboardCesiumWriter

Opens and returns the writer for the billboard property. The billboard property defines a billboard, or viewport-aligned image, sometimes called a marker. The billboard is positioned in the scene by the position property.

OpenBoxProperty ( ) : BoxCesiumWriter

Opens and returns the writer for the box property. The box property defines a box, which is a closed rectangular cuboid. The box is positioned and oriented using the position and orientation properties.

OpenClockProperty ( ) : ClockCesiumWriter

Opens and returns the writer for the clock property. The clock property defines the clock settings for the entire data set. Only valid on the document object.

OpenConicSensorProperty ( ) : ConicSensorCesiumWriter

Opens and returns the writer for the agi_conicSensor property. The agi_conicSensor property defines a conical sensor volume taking into account occlusion of an ellipsoid, i.e., the globe. The sensor is is positioned and oriented using the position and orientation properties.

OpenCorridorProperty ( ) : CorridorCesiumWriter

Opens and returns the writer for the corridor property. The corridor property defines a corridor, which is a shape defined by a centerline and width.

OpenCustomPatternSensorProperty ( ) : CustomPatternSensorCesiumWriter

Opens and returns the writer for the agi_customPatternSensor property. The agi_customPatternSensor property defines a custom sensor volume taking into account occlusion of an ellipsoid, i.e., the globe. The sensor is is positioned and oriented using the position and orientation properties.

OpenCylinderProperty ( ) : CylinderCesiumWriter

Opens and returns the writer for the cylinder property. The cylinder property defines a cylinder, truncated cone, or cone defined by a length, top radius, and bottom radius. The cylinder is positioned and oriented using the position and orientation properties.

OpenDescriptionProperty ( ) : StringCesiumWriter

Opens and returns the writer for the description property. The description property defines an HTML description of the object.

OpenEllipseProperty ( ) : EllipseCesiumWriter

Opens and returns the writer for the ellipse property. The ellipse property defines an ellipse, which is a closed curve on the surface of the Earth. The ellipse is positioned using the position property.

OpenEllipsoidProperty ( ) : EllipsoidCesiumWriter

Opens and returns the writer for the ellipsoid property. The ellipsoid property defines an ellipsoid, which is a closed quadric surface that is a three dimensional analogue of an ellipse. The ellipsoid is positioned and oriented using the position and orientation properties.

OpenFanProperty ( ) : FanCesiumWriter

Opens and returns the writer for the agi_fan property. The agi_fan property defines defines a fan, which starts at a point or apex and extends in a specified list of directions from the apex. Each pair of directions forms a face of the fan extending to the specified radius. The fan is positioned and oriented using the position and orientation properties.

OpenLabelProperty ( ) : LabelCesiumWriter

Opens and returns the writer for the label property. The label property defines a string of text. The label is positioned in the scene by the position property.

OpenModelProperty ( ) : ModelCesiumWriter

Opens and returns the writer for the model property. The model property defines a 3D model. The model is positioned and oriented using the position and orientation properties.

OpenOrientationProperty ( ) : OrientationCesiumWriter

Opens and returns the writer for the orientation property. The orientation property defines the orientation of the object in the world. The orientation has no direct visual representation, but it is used to orient models, cones, pyramids, and other graphical items attached to the object.

OpenPathProperty ( ) : PathCesiumWriter

Opens and returns the writer for the path property. The path property defines a path, which is a polyline defined by the motion of an object over time. The possible vertices of the path are specified by the position property.

OpenPointProperty ( ) : PointCesiumWriter

Opens and returns the writer for the point property. The point property defines a point, or viewport-aligned circle. The point is positioned in the scene by the position property.

OpenPolygonProperty ( ) : PolygonCesiumWriter

Opens and returns the writer for the polygon property. The polygon property defines a polygon, which is a closed figure on the surface of the Earth.

OpenPolylineProperty ( ) : PolylineCesiumWriter

Opens and returns the writer for the polyline property. The polyline property defines a polyline, which is a line in the scene composed of multiple segments.

OpenPositionProperty ( ) : PositionCesiumWriter

Opens and returns the writer for the position property. The position property defines the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.

OpenRectangleProperty ( ) : RectangleCesiumWriter

Opens and returns the writer for the rectangle property. The rectangle property defines a cartographic rectangle, which conforms to the curvature of the globe and can be placed along the surface or at altitude.

OpenRectangularSensorProperty ( ) : RectangularSensorCesiumWriter

Opens and returns the writer for the agi_rectangularSensor property. The agi_rectangularSensor property defines a rectangular pyramid sensor volume taking into account occlusion of an ellipsoid, i.e., the globe. The sensor is is positioned and oriented using the position and orientation properties.

OpenVectorProperty ( ) : VectorCesiumWriter

Opens and returns the writer for the agi_vector property. The agi_vector property defines defines a graphical vector that originates at the position property and extends in the provided direction for the provided length. The vector is positioned using the position property.

OpenViewFromProperty ( ) : ViewFromCesiumWriter

Opens and returns the writer for the viewFrom property. The viewFrom property defines a suggested camera location when viewing this object. The property is specified as a Cartesian position in the East (x), North (y), Up (z) reference frame relative to the object's position.

OpenWallProperty ( ) : WallCesiumWriter

Opens and returns the writer for the wall property. The wall property defines a two dimensional wall which conforms to the curvature of the globe and can be placed along the surface or at altitude.

WriteAvailability ( IList value ) : void

Writes the value expressed as a availability, which is the set of time intervals over which data for an object is available. The property can be a single string specifying a single interval, or an array of strings representing intervals. A later Cesium packet can update this availability if it changes or is found to be incorrect. For example, an SGP4 propagator may initially report availability for all time, but then later the propagator throws an exception and the availability can be adjusted to end at that time. If this optional property is not present, the object is assumed to be available for all time. Availability is scoped to a particular CZML stream, so two different streams can list different availability for a single object. Within a single stream, the last availability stated for an object is the one in effect and any availabilities in previous packets are ignored. If an object is not available at a time, the client will not draw that object. If not specified, the default value is 0000-00-00T00:00:00Z/9999-12-31T24:00:00Z.

WriteAvailability ( JulianDate start, JulianDate stop ) : void

Writes the value expressed as a availability, which is the set of time intervals over which data for an object is available. The property can be a single string specifying a single interval, or an array of strings representing intervals. A later Cesium packet can update this availability if it changes or is found to be incorrect. For example, an SGP4 propagator may initially report availability for all time, but then later the propagator throws an exception and the availability can be adjusted to end at that time. If this optional property is not present, the object is assumed to be available for all time. Availability is scoped to a particular CZML stream, so two different streams can list different availability for a single object. Within a single stream, the last availability stated for an object is the one in effect and any availabilities in previous packets are ignored. If an object is not available at a time, the client will not draw that object. If not specified, the default value is 0000-00-00T00:00:00Z/9999-12-31T24:00:00Z.

WriteAvailability ( TimeInterval value ) : void

Writes the value expressed as a availability, which is the set of time intervals over which data for an object is available. The property can be a single string specifying a single interval, or an array of strings representing intervals. A later Cesium packet can update this availability if it changes or is found to be incorrect. For example, an SGP4 propagator may initially report availability for all time, but then later the propagator throws an exception and the availability can be adjusted to end at that time. If this optional property is not present, the object is assumed to be available for all time. Availability is scoped to a particular CZML stream, so two different streams can list different availability for a single object. Within a single stream, the last availability stated for an object is the one in effect and any availabilities in previous packets are ignored. If an object is not available at a time, the client will not draw that object. If not specified, the default value is 0000-00-00T00:00:00Z/9999-12-31T24:00:00Z.

WriteDelete ( bool value ) : void

Writes the value expressed as a delete, which is 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.

WriteDescriptionProperty ( string value ) : void

Writes a value for the description property as a string value. The description property specifies an HTML description of the object.

WriteDescriptionPropertyReference ( Reference value ) : void

Writes a value for the description property as a reference value. The description property specifies an HTML description of the object.

WriteDescriptionPropertyReference ( string value ) : void

Writes a value for the description property as a reference value. The description property specifies an HTML description of the object.

WriteDescriptionPropertyReference ( string identifier, string propertyName ) : void

Writes a value for the description property as a reference value. The description property specifies an HTML description of the object.

WriteId ( string value ) : void

Writes the value expressed as a id, which is 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 add more data to it.

WriteName ( string value ) : void

Writes the value expressed as a name, which is the name of the object. It does not have to be unique and is intended for user consumption.

WriteOrientationProperty ( IList dates, IList values ) : void

Writes a value for the orientation property as a unitQuaternion value. The orientation property specifies the orientation of the object in the world. The orientation has no direct visual representation, but it is used to orient models, cones, pyramids, and other graphical items attached to the object.

WriteOrientationProperty ( IList dates, IList values, int startIndex, int length ) : void

Writes a value for the orientation property as a unitQuaternion value. The orientation property specifies the orientation of the object in the world. The orientation has no direct visual representation, but it is used to orient models, cones, pyramids, and other graphical items attached to the object.

WriteOrientationProperty ( UnitQuaternion value ) : void

Writes a value for the orientation property as a unitQuaternion value. The orientation property specifies the orientation of the object in the world. The orientation has no direct visual representation, but it is used to orient models, cones, pyramids, and other graphical items attached to the object.

WriteOrientationPropertyReference ( Reference value ) : void

Writes a value for the orientation property as a reference value. The orientation property specifies the orientation of the object in the world. The orientation has no direct visual representation, but it is used to orient models, cones, pyramids, and other graphical items attached to the object.

WriteOrientationPropertyReference ( string value ) : void

Writes a value for the orientation property as a reference value. The orientation property specifies the orientation of the object in the world. The orientation has no direct visual representation, but it is used to orient models, cones, pyramids, and other graphical items attached to the object.

WriteOrientationPropertyReference ( string identifier, string propertyName ) : void

Writes a value for the orientation property as a reference value. The orientation property specifies the orientation of the object in the world. The orientation has no direct visual representation, but it is used to orient models, cones, pyramids, and other graphical items attached to the object.

WriteParent ( string value ) : void

Writes the value expressed as a parent, which is the ID of the parent object, if any.

WritePositionProperty ( Cartesian value ) : void

Writes a value for the position property as a cartesian value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.

WritePositionProperty ( IList dates, IList values ) : void

Writes a value for the position property as a cartesian value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.

WritePositionProperty ( IList dates, IList values, int startIndex, int length ) : void

Writes a value for the position property as a cartesian value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.

WritePositionPropertyCartesianVelocity ( IList dates, IList values ) : void

Writes a value for the position property as a cartesianVelocity value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.

WritePositionPropertyCartesianVelocity ( IList dates, IList values, int startIndex, int length ) : void

Writes a value for the position property as a cartesianVelocity value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.

WritePositionPropertyCartesianVelocity ( Motion value ) : void

Writes a value for the position property as a cartesianVelocity value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.

WritePositionPropertyCartographicDegrees ( Cartographic value ) : void

Writes a value for the position property as a cartographicDegrees value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.

WritePositionPropertyCartographicDegrees ( IList dates, IList values ) : void

Writes a value for the position property as a cartographicDegrees value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.

WritePositionPropertyCartographicDegrees ( IList dates, IList values, int startIndex, int length ) : void

Writes a value for the position property as a cartographicDegrees value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.

WritePositionPropertyCartographicRadians ( Cartographic value ) : void

Writes a value for the position property as a cartographicRadians value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.

WritePositionPropertyCartographicRadians ( IList dates, IList values ) : void

Writes a value for the position property as a cartographicRadians value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.

WritePositionPropertyCartographicRadians ( IList dates, IList values, int startIndex, int length ) : void

Writes a value for the position property as a cartographicRadians value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.

WritePositionPropertyReference ( Reference value ) : void

Writes a value for the position property as a reference value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.

WritePositionPropertyReference ( string value ) : void

Writes a value for the position property as a reference value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.

WritePositionPropertyReference ( string identifier, string propertyName ) : void

Writes a value for the position property as a reference value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.

WriteVersion ( string value ) : void

Writes the value expressed as a version, which is the CZML version being written. Only valid on the document object.

WriteViewFromProperty ( Cartesian value ) : void

Writes a value for the viewFrom property as a cartesian value. The viewFrom property specifies a suggested camera location when viewing this object. The property is specified as a Cartesian position in the East (x), North (y), Up (z) reference frame relative to the object's position.

WriteViewFromProperty ( IList dates, IList values ) : void

Writes a value for the viewFrom property as a cartesian value. The viewFrom property specifies a suggested camera location when viewing this object. The property is specified as a Cartesian position in the East (x), North (y), Up (z) reference frame relative to the object's position.

WriteViewFromProperty ( IList dates, IList values, int startIndex, int length ) : void

Writes a value for the viewFrom property as a cartesian value. The viewFrom property specifies a suggested camera location when viewing this object. The property is specified as a Cartesian position in the East (x), North (y), Up (z) reference frame relative to the object's position.

WriteViewFromPropertyReference ( Reference value ) : void

Writes a value for the viewFrom property as a reference value. The viewFrom property specifies a suggested camera location when viewing this object. The property is specified as a Cartesian position in the East (x), North (y), Up (z) reference frame relative to the object's position.

WriteViewFromPropertyReference ( string value ) : void

Writes a value for the viewFrom property as a reference value. The viewFrom property specifies a suggested camera location when viewing this object. The property is specified as a Cartesian position in the East (x), North (y), Up (z) reference frame relative to the object's position.

WriteViewFromPropertyReference ( string identifier, string propertyName ) : void

Writes a value for the viewFrom property as a reference value. The viewFrom property specifies a suggested camera location when viewing this object. The property is specified as a Cartesian position in the East (x), North (y), Up (z) reference frame relative to the object's position.

Protected Methods

Method Description
OnClose ( ) : void

Writes the end of the JSON object representing the packet.

OnOpen ( ) : void

Writes the start of a new JSON object representing the packet.

Method Details

OnClose() protected method

Writes the end of the JSON object representing the packet.
protected OnClose ( ) : void
return void

OnOpen() protected method

Writes the start of a new JSON object representing the packet.
protected OnOpen ( ) : void
return void

OpenBillboardProperty() public method

Opens and returns the writer for the billboard property. The billboard property defines a billboard, or viewport-aligned image, sometimes called a marker. The billboard is positioned in the scene by the position property.
public OpenBillboardProperty ( ) : BillboardCesiumWriter
return BillboardCesiumWriter

OpenBoxProperty() public method

Opens and returns the writer for the box property. The box property defines a box, which is a closed rectangular cuboid. The box is positioned and oriented using the position and orientation properties.
public OpenBoxProperty ( ) : BoxCesiumWriter
return BoxCesiumWriter

OpenClockProperty() public method

Opens and returns the writer for the clock property. The clock property defines the clock settings for the entire data set. Only valid on the document object.
public OpenClockProperty ( ) : ClockCesiumWriter
return ClockCesiumWriter

OpenConicSensorProperty() public method

Opens and returns the writer for the agi_conicSensor property. The agi_conicSensor property defines a conical sensor volume taking into account occlusion of an ellipsoid, i.e., the globe. The sensor is is positioned and oriented using the position and orientation properties.
public OpenConicSensorProperty ( ) : ConicSensorCesiumWriter
return ConicSensorCesiumWriter

OpenCorridorProperty() public method

Opens and returns the writer for the corridor property. The corridor property defines a corridor, which is a shape defined by a centerline and width.
public OpenCorridorProperty ( ) : CorridorCesiumWriter
return CorridorCesiumWriter

OpenCustomPatternSensorProperty() public method

Opens and returns the writer for the agi_customPatternSensor property. The agi_customPatternSensor property defines a custom sensor volume taking into account occlusion of an ellipsoid, i.e., the globe. The sensor is is positioned and oriented using the position and orientation properties.
public OpenCustomPatternSensorProperty ( ) : CustomPatternSensorCesiumWriter
return CustomPatternSensorCesiumWriter

OpenCylinderProperty() public method

Opens and returns the writer for the cylinder property. The cylinder property defines a cylinder, truncated cone, or cone defined by a length, top radius, and bottom radius. The cylinder is positioned and oriented using the position and orientation properties.
public OpenCylinderProperty ( ) : CylinderCesiumWriter
return CylinderCesiumWriter

OpenDescriptionProperty() public method

Opens and returns the writer for the description property. The description property defines an HTML description of the object.
public OpenDescriptionProperty ( ) : StringCesiumWriter
return StringCesiumWriter

OpenEllipseProperty() public method

Opens and returns the writer for the ellipse property. The ellipse property defines an ellipse, which is a closed curve on the surface of the Earth. The ellipse is positioned using the position property.
public OpenEllipseProperty ( ) : EllipseCesiumWriter
return EllipseCesiumWriter

OpenEllipsoidProperty() public method

Opens and returns the writer for the ellipsoid property. The ellipsoid property defines an ellipsoid, which is a closed quadric surface that is a three dimensional analogue of an ellipse. The ellipsoid is positioned and oriented using the position and orientation properties.
public OpenEllipsoidProperty ( ) : EllipsoidCesiumWriter
return EllipsoidCesiumWriter

OpenFanProperty() public method

Opens and returns the writer for the agi_fan property. The agi_fan property defines defines a fan, which starts at a point or apex and extends in a specified list of directions from the apex. Each pair of directions forms a face of the fan extending to the specified radius. The fan is positioned and oriented using the position and orientation properties.
public OpenFanProperty ( ) : FanCesiumWriter
return FanCesiumWriter

OpenLabelProperty() public method

Opens and returns the writer for the label property. The label property defines a string of text. The label is positioned in the scene by the position property.
public OpenLabelProperty ( ) : LabelCesiumWriter
return LabelCesiumWriter

OpenModelProperty() public method

Opens and returns the writer for the model property. The model property defines a 3D model. The model is positioned and oriented using the position and orientation properties.
public OpenModelProperty ( ) : ModelCesiumWriter
return ModelCesiumWriter

OpenOrientationProperty() public method

Opens and returns the writer for the orientation property. The orientation property defines the orientation of the object in the world. The orientation has no direct visual representation, but it is used to orient models, cones, pyramids, and other graphical items attached to the object.
public OpenOrientationProperty ( ) : OrientationCesiumWriter
return OrientationCesiumWriter

OpenPathProperty() public method

Opens and returns the writer for the path property. The path property defines a path, which is a polyline defined by the motion of an object over time. The possible vertices of the path are specified by the position property.
public OpenPathProperty ( ) : PathCesiumWriter
return PathCesiumWriter

OpenPointProperty() public method

Opens and returns the writer for the point property. The point property defines a point, or viewport-aligned circle. The point is positioned in the scene by the position property.
public OpenPointProperty ( ) : PointCesiumWriter
return PointCesiumWriter

OpenPolygonProperty() public method

Opens and returns the writer for the polygon property. The polygon property defines a polygon, which is a closed figure on the surface of the Earth.
public OpenPolygonProperty ( ) : PolygonCesiumWriter
return PolygonCesiumWriter

OpenPolylineProperty() public method

Opens and returns the writer for the polyline property. The polyline property defines a polyline, which is a line in the scene composed of multiple segments.
public OpenPolylineProperty ( ) : PolylineCesiumWriter
return PolylineCesiumWriter

OpenPositionProperty() public method

Opens and returns the writer for the position property. The position property defines the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.
public OpenPositionProperty ( ) : PositionCesiumWriter
return PositionCesiumWriter

OpenRectangleProperty() public method

Opens and returns the writer for the rectangle property. The rectangle property defines a cartographic rectangle, which conforms to the curvature of the globe and can be placed along the surface or at altitude.
public OpenRectangleProperty ( ) : RectangleCesiumWriter
return RectangleCesiumWriter

OpenRectangularSensorProperty() public method

Opens and returns the writer for the agi_rectangularSensor property. The agi_rectangularSensor property defines a rectangular pyramid sensor volume taking into account occlusion of an ellipsoid, i.e., the globe. The sensor is is positioned and oriented using the position and orientation properties.
public OpenRectangularSensorProperty ( ) : RectangularSensorCesiumWriter
return RectangularSensorCesiumWriter

OpenVectorProperty() public method

Opens and returns the writer for the agi_vector property. The agi_vector property defines defines a graphical vector that originates at the position property and extends in the provided direction for the provided length. The vector is positioned using the position property.
public OpenVectorProperty ( ) : VectorCesiumWriter
return VectorCesiumWriter

OpenViewFromProperty() public method

Opens and returns the writer for the viewFrom property. The viewFrom property defines a suggested camera location when viewing this object. The property is specified as a Cartesian position in the East (x), North (y), Up (z) reference frame relative to the object's position.
public OpenViewFromProperty ( ) : ViewFromCesiumWriter
return ViewFromCesiumWriter

OpenWallProperty() public method

Opens and returns the writer for the wall property. The wall property defines a two dimensional wall which conforms to the curvature of the globe and can be placed along the surface or at altitude.
public OpenWallProperty ( ) : WallCesiumWriter
return WallCesiumWriter

WriteAvailability() public method

Writes the value expressed as a availability, which is the set of time intervals over which data for an object is available. The property can be a single string specifying a single interval, or an array of strings representing intervals. A later Cesium packet can update this availability if it changes or is found to be incorrect. For example, an SGP4 propagator may initially report availability for all time, but then later the propagator throws an exception and the availability can be adjusted to end at that time. If this optional property is not present, the object is assumed to be available for all time. Availability is scoped to a particular CZML stream, so two different streams can list different availability for a single object. Within a single stream, the last availability stated for an object is the one in effect and any availabilities in previous packets are ignored. If an object is not available at a time, the client will not draw that object. If not specified, the default value is 0000-00-00T00:00:00Z/9999-12-31T24:00:00Z.
public WriteAvailability ( IList value ) : void
value IList The intervals.
return void

WriteAvailability() public method

Writes the value expressed as a availability, which is the set of time intervals over which data for an object is available. The property can be a single string specifying a single interval, or an array of strings representing intervals. A later Cesium packet can update this availability if it changes or is found to be incorrect. For example, an SGP4 propagator may initially report availability for all time, but then later the propagator throws an exception and the availability can be adjusted to end at that time. If this optional property is not present, the object is assumed to be available for all time. Availability is scoped to a particular CZML stream, so two different streams can list different availability for a single object. Within a single stream, the last availability stated for an object is the one in effect and any availabilities in previous packets are ignored. If an object is not available at a time, the client will not draw that object. If not specified, the default value is 0000-00-00T00:00:00Z/9999-12-31T24:00:00Z.
public WriteAvailability ( JulianDate start, JulianDate stop ) : void
start JulianDate The earliest date of the interval.
stop JulianDate The latest date of the interval.
return void

WriteAvailability() public method

Writes the value expressed as a availability, which is the set of time intervals over which data for an object is available. The property can be a single string specifying a single interval, or an array of strings representing intervals. A later Cesium packet can update this availability if it changes or is found to be incorrect. For example, an SGP4 propagator may initially report availability for all time, but then later the propagator throws an exception and the availability can be adjusted to end at that time. If this optional property is not present, the object is assumed to be available for all time. Availability is scoped to a particular CZML stream, so two different streams can list different availability for a single object. Within a single stream, the last availability stated for an object is the one in effect and any availabilities in previous packets are ignored. If an object is not available at a time, the client will not draw that object. If not specified, the default value is 0000-00-00T00:00:00Z/9999-12-31T24:00:00Z.
public WriteAvailability ( TimeInterval value ) : void
value TimeInterval The interval.
return void

WriteDelete() public method

Writes the value expressed as a delete, which is 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.
public WriteDelete ( bool value ) : void
value bool The value.
return void

WriteDescriptionProperty() public method

Writes a value for the description property as a string value. The description property specifies an HTML description of the object.
public WriteDescriptionProperty ( string value ) : void
value string The value.
return void

WriteDescriptionPropertyReference() public method

Writes a value for the description property as a reference value. The description property specifies an HTML description of the object.
public WriteDescriptionPropertyReference ( Reference value ) : void
value Reference The reference.
return void

WriteDescriptionPropertyReference() public method

Writes a value for the description property as a reference value. The description property specifies an HTML description of the object.
public WriteDescriptionPropertyReference ( string value ) : void
value string The earliest date of the interval.
return void

WriteDescriptionPropertyReference() public method

Writes a value for the description property as a reference value. The description property specifies an HTML description of the object.
public WriteDescriptionPropertyReference ( string identifier, string propertyName ) : void
identifier string The identifier of the object which contains the referenced property.
propertyName string The property on the referenced object.
return void

WriteId() public method

Writes the value expressed as a id, which is 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 add more data to it.
public WriteId ( string value ) : void
value string The value.
return void

WriteName() public method

Writes the value expressed as a name, which is the name of the object. It does not have to be unique and is intended for user consumption.
public WriteName ( string value ) : void
value string The value.
return void

WriteOrientationProperty() public method

Writes a value for the orientation property as a unitQuaternion value. The orientation property specifies the orientation of the object in the world. The orientation has no direct visual representation, but it is used to orient models, cones, pyramids, and other graphical items attached to the object.
public WriteOrientationProperty ( IList dates, IList values ) : void
dates IList The dates at which the value is specified.
values IList The values corresponding to each date.
return void

WriteOrientationProperty() public method

Writes a value for the orientation property as a unitQuaternion value. The orientation property specifies the orientation of the object in the world. The orientation has no direct visual representation, but it is used to orient models, cones, pyramids, and other graphical items attached to the object.
public WriteOrientationProperty ( IList dates, IList values, int startIndex, int length ) : void
dates IList The dates at which the value is specified.
values IList The values corresponding to each date.
startIndex int The index of the first element to write.
length int The number of elements to write.
return void

WriteOrientationProperty() public method

Writes a value for the orientation property as a unitQuaternion value. The orientation property specifies the orientation of the object in the world. The orientation has no direct visual representation, but it is used to orient models, cones, pyramids, and other graphical items attached to the object.
public WriteOrientationProperty ( UnitQuaternion value ) : void
value UnitQuaternion The value.
return void

WriteOrientationPropertyReference() public method

Writes a value for the orientation property as a reference value. The orientation property specifies the orientation of the object in the world. The orientation has no direct visual representation, but it is used to orient models, cones, pyramids, and other graphical items attached to the object.
public WriteOrientationPropertyReference ( Reference value ) : void
value Reference The reference.
return void

WriteOrientationPropertyReference() public method

Writes a value for the orientation property as a reference value. The orientation property specifies the orientation of the object in the world. The orientation has no direct visual representation, but it is used to orient models, cones, pyramids, and other graphical items attached to the object.
public WriteOrientationPropertyReference ( string value ) : void
value string The earliest date of the interval.
return void

WriteOrientationPropertyReference() public method

Writes a value for the orientation property as a reference value. The orientation property specifies the orientation of the object in the world. The orientation has no direct visual representation, but it is used to orient models, cones, pyramids, and other graphical items attached to the object.
public WriteOrientationPropertyReference ( string identifier, string propertyName ) : void
identifier string The identifier of the object which contains the referenced property.
propertyName string The property on the referenced object.
return void

WriteParent() public method

Writes the value expressed as a parent, which is the ID of the parent object, if any.
public WriteParent ( string value ) : void
value string The value.
return void

WritePositionProperty() public method

Writes a value for the position property as a cartesian value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.
public WritePositionProperty ( Cartesian value ) : void
value Cartesian The value.
return void

WritePositionProperty() public method

Writes a value for the position property as a cartesian value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.
public WritePositionProperty ( IList dates, IList values ) : void
dates IList The dates at which the value is specified.
values IList The values corresponding to each date.
return void

WritePositionProperty() public method

Writes a value for the position property as a cartesian value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.
public WritePositionProperty ( IList dates, IList values, int startIndex, int length ) : void
dates IList The dates at which the value is specified.
values IList The values corresponding to each date.
startIndex int The index of the first element to write.
length int The number of elements to write.
return void

WritePositionPropertyCartesianVelocity() public method

Writes a value for the position property as a cartesianVelocity value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.
public WritePositionPropertyCartesianVelocity ( IList dates, IList values ) : void
dates IList The dates at which the value is specified.
values IList The values corresponding to each date.
return void

WritePositionPropertyCartesianVelocity() public method

Writes a value for the position property as a cartesianVelocity value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.
public WritePositionPropertyCartesianVelocity ( IList dates, IList values, int startIndex, int length ) : void
dates IList The dates at which the value is specified.
values IList The values corresponding to each date.
startIndex int The index of the first element to write.
length int The number of elements to write.
return void

WritePositionPropertyCartesianVelocity() public method

Writes a value for the position property as a cartesianVelocity value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.
public WritePositionPropertyCartesianVelocity ( Motion value ) : void
value Motion The value.
return void

WritePositionPropertyCartographicDegrees() public method

Writes a value for the position property as a cartographicDegrees value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.
public WritePositionPropertyCartographicDegrees ( Cartographic value ) : void
value Cartographic The interval.
return void

WritePositionPropertyCartographicDegrees() public method

Writes a value for the position property as a cartographicDegrees value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.
public WritePositionPropertyCartographicDegrees ( IList dates, IList values ) : void
dates IList The dates at which the value is specified.
values IList The values corresponding to each date.
return void

WritePositionPropertyCartographicDegrees() public method

Writes a value for the position property as a cartographicDegrees value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.
public WritePositionPropertyCartographicDegrees ( IList dates, IList values, int startIndex, int length ) : void
dates IList The dates at which the value is specified.
values IList The position corresponding to each date.
startIndex int The index of the first element to write.
length int The number of elements to write.
return void

WritePositionPropertyCartographicRadians() public method

Writes a value for the position property as a cartographicRadians value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.
public WritePositionPropertyCartographicRadians ( Cartographic value ) : void
value Cartographic The interval.
return void

WritePositionPropertyCartographicRadians() public method

Writes a value for the position property as a cartographicRadians value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.
public WritePositionPropertyCartographicRadians ( IList dates, IList values ) : void
dates IList The dates at which the value is specified.
values IList The values corresponding to each date.
return void

WritePositionPropertyCartographicRadians() public method

Writes a value for the position property as a cartographicRadians value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.
public WritePositionPropertyCartographicRadians ( IList dates, IList values, int startIndex, int length ) : void
dates IList The dates at which the value is specified.
values IList The position corresponding to each date.
startIndex int The index of the first element to write.
length int The number of elements to write.
return void

WritePositionPropertyReference() public method

Writes a value for the position property as a reference value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.
public WritePositionPropertyReference ( Reference value ) : void
value Reference The reference.
return void

WritePositionPropertyReference() public method

Writes a value for the position property as a reference value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.
public WritePositionPropertyReference ( string value ) : void
value string The earliest date of the interval.
return void

WritePositionPropertyReference() public method

Writes a value for the position property as a reference value. The position property specifies the position of the object in the world. The position has no direct visual representation, but it is used to locate billboards, labels, and other graphical items attached to the object.
public WritePositionPropertyReference ( string identifier, string propertyName ) : void
identifier string The identifier of the object which contains the referenced property.
propertyName string The property on the referenced object.
return void

WriteVersion() public method

Writes the value expressed as a version, which is the CZML version being written. Only valid on the document object.
public WriteVersion ( string value ) : void
value string The value.
return void

WriteViewFromProperty() public method

Writes a value for the viewFrom property as a cartesian value. The viewFrom property specifies a suggested camera location when viewing this object. The property is specified as a Cartesian position in the East (x), North (y), Up (z) reference frame relative to the object's position.
public WriteViewFromProperty ( Cartesian value ) : void
value Cartesian The value.
return void

WriteViewFromProperty() public method

Writes a value for the viewFrom property as a cartesian value. The viewFrom property specifies a suggested camera location when viewing this object. The property is specified as a Cartesian position in the East (x), North (y), Up (z) reference frame relative to the object's position.
public WriteViewFromProperty ( IList dates, IList values ) : void
dates IList The dates at which the value is specified.
values IList The values corresponding to each date.
return void

WriteViewFromProperty() public method

Writes a value for the viewFrom property as a cartesian value. The viewFrom property specifies a suggested camera location when viewing this object. The property is specified as a Cartesian position in the East (x), North (y), Up (z) reference frame relative to the object's position.
public WriteViewFromProperty ( IList dates, IList values, int startIndex, int length ) : void
dates IList The dates at which the value is specified.
values IList The values corresponding to each date.
startIndex int The index of the first element to write.
length int The number of elements to write.
return void

WriteViewFromPropertyReference() public method

Writes a value for the viewFrom property as a reference value. The viewFrom property specifies a suggested camera location when viewing this object. The property is specified as a Cartesian position in the East (x), North (y), Up (z) reference frame relative to the object's position.
public WriteViewFromPropertyReference ( Reference value ) : void
value Reference The reference.
return void

WriteViewFromPropertyReference() public method

Writes a value for the viewFrom property as a reference value. The viewFrom property specifies a suggested camera location when viewing this object. The property is specified as a Cartesian position in the East (x), North (y), Up (z) reference frame relative to the object's position.
public WriteViewFromPropertyReference ( string value ) : void
value string The earliest date of the interval.
return void

WriteViewFromPropertyReference() public method

Writes a value for the viewFrom property as a reference value. The viewFrom property specifies a suggested camera location when viewing this object. The property is specified as a Cartesian position in the East (x), North (y), Up (z) reference frame relative to the object's position.
public WriteViewFromPropertyReference ( string identifier, string propertyName ) : void
identifier string The identifier of the object which contains the referenced property.
propertyName string The property on the referenced object.
return void