/**
* Gets the {@link PacketCesiumWriter} that this instances uses to write packets. The packet
* writer must be opened by calling {@link CesiumElementWriter#open} before it can be use for
* writing. Consider calling {@link #openPacket} instead, which returns the same instance but
* opens it first.
*/
public final PacketCesiumWriter getPacketWriter() {
return m_packetWriter.getValue();
}
/**
* Gets the writer for the <code>clock</code> property. The returned instance must be opened by
* calling the {@link CesiumElementWriter#open} method before it can be used for writing. The
* <code>clock</code> property defines a simulated clock.
*/
public final ClockCesiumWriter getClockWriter() {
return m_clock.getValue();
}
/**
* Starts a new CZML packet on the given stream.
*
* @param output The stream to which to write the packet.
* @return The packet writer.
*/
public final PacketCesiumWriter openPacket(CesiumOutputStream output) {
PacketCesiumWriter packetWriter = m_packetWriter.getValue();
packetWriter.open(output);
return packetWriter;
}
/**
* Gets the writer for the <code>ellipsoid</code> property. The returned instance must be opened
* by calling the {@link CesiumElementWriter#open} method before it can be used for writing. The
* <code>ellipsoid</code> 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 final EllipsoidCesiumWriter getEllipsoidWriter() {
return m_ellipsoid.getValue();
}
/**
* Gets the writer for the <code>ellipse</code> property. The returned instance must be opened by
* calling the {@link CesiumElementWriter#open} method before it can be used for writing. The
* <code>ellipse</code> property defines an ellipse, which is a closed curve on the surface of the
* Earth. The ellipse is positioned using the `position` property.
*/
public final EllipseCesiumWriter getEllipseWriter() {
return m_ellipse.getValue();
}
/**
* Gets the writer for the <code>pyramid</code> property. The returned instance must be opened by
* calling the {@link CesiumElementWriter#open} method before it can be used for writing. The
* <code>pyramid</code> property defines a pyramid. A pyramid 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 pyramid. The pyramid may be capped at a radial limit.
*/
public final PyramidCesiumWriter getPyramidWriter() {
return m_pyramid.getValue();
}
/**
* Gets the writer for the <code>camera</code> property. The returned instance must be opened by
* calling the {@link CesiumElementWriter#open} method before it can be used for writing. The
* <code>camera</code> property defines a camera.
*/
public final CameraCesiumWriter getCameraWriter() {
return m_camera.getValue();
}
/**
* Gets the writer for the <code>polygon</code> property. The returned instance must be opened by
* calling the {@link CesiumElementWriter#open} method before it can be used for writing. The
* <code>polygon</code> property defines a polygon, which is a closed figure on the surface of the
* Earth. The vertices of the polygon are specified by the `vertexPositions` property.
*/
public final PolygonCesiumWriter getPolygonWriter() {
return m_polygon.getValue();
}
/**
* Gets the writer for the <code>cone</code> property. The returned instance must be opened by
* calling the {@link CesiumElementWriter#open} method before it can be used for writing. The
* <code>cone</code> property defines a cone. A cone starts at a point or apex and extends in a
* circle of directions which all have the same angular separation from the Z-axis of the object
* to which the cone is attached. The cone may be capped at a radial limit, it may have an inner
* hole, and it may be only a part of a complete cone defined by clock angle limits. The apex
* point of the cone is defined by the `position` property and extends in the direction of the
* Z-axis as defined by the `orientation` property.
*/
public final ConeCesiumWriter getConeWriter() {
return m_cone.getValue();
}
/**
* Gets the writer for the <code>polyline</code> property. The returned instance must be opened by
* calling the {@link CesiumElementWriter#open} method before it can be used for writing. The
* <code>polyline</code> property defines a polyline, which is a line in the scene composed of
* multiple segments. The vertices of the polyline are specified by the `vertexPositions`
* property.
*/
public final PolylineCesiumWriter getPolylineWriter() {
return m_polyline.getValue();
}
/**
* Gets the writer for the <code>path</code> property. The returned instance must be opened by
* calling the {@link CesiumElementWriter#open} method before it can be used for writing. The
* <code>path</code> 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 final PathCesiumWriter getPathWriter() {
return m_path.getValue();
}
/**
* Gets the writer for the <code>label</code> property. The returned instance must be opened by
* calling the {@link CesiumElementWriter#open} method before it can be used for writing. The
* <code>label</code> property defines a string of text. The label is positioned in the scene by
* the `position` property.
*/
public final LabelCesiumWriter getLabelWriter() {
return m_label.getValue();
}
/**
* Gets the writer for the <code>point</code> property. The returned instance must be opened by
* calling the {@link CesiumElementWriter#open} method before it can be used for writing. The
* <code>point</code> property defines a point, or viewport-aligned circle. The point is
* positioned in the scene by the `position` property.
*/
public final PointCesiumWriter getPointWriter() {
return m_point.getValue();
}
/**
* Gets the writer for the <code>orientation</code> property. The returned instance must be opened
* by calling the {@link CesiumElementWriter#open} method before it can be used for writing. The
* <code>orientation</code> 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, and
* pyramids attached to the object.
*/
public final OrientationCesiumWriter getOrientationWriter() {
return m_orientation.getValue();
}
/**
* Gets the writer for the <code>vertexPositions</code> property. The returned instance must be
* opened by calling the {@link CesiumElementWriter#open} method before it can be used for
* writing. The <code>vertexPositions</code> property defines the world-space positions of
* vertices. The vertex positions have no direct visual representation, but they are used to
* define polygons, polylines, and other objects attached to the object.
*/
public final PositionListCesiumWriter getVertexPositionsWriter() {
return m_vertexPositions.getValue();
}
/**
* Gets the writer for the <code>billboard</code> property. The returned instance must be opened
* by calling the {@link CesiumElementWriter#open} method before it can be used for writing. The
* <code>billboard</code> property defines a billboard, or viewport-aligned image. The billboard
* is positioned in the scene by the position property. A billboard is sometimes called a marker.
*/
public final BillboardCesiumWriter getBillboardWriter() {
return m_billboard.getValue();
}