Class: PathGraphics

PathGraphics

new PathGraphics(optionsopt)

Describes a polyline defined as the path made by an Entity as it moves over time.
Parameters:
Name Type Attributes Description
options Object <optional>
 Object with the following properties:
Properties
Name Type Attributes Default Description
leadTime Property <optional>
 A Property specifying the number of seconds behind the object to show.
trailTime Property <optional>
 A Property specifying the number of seconds in front of the object to show.
show Property <optional>
 true A boolean Property specifying the visibility of the path.
width Property <optional>
 1.0 A numeric Property specifying the width in pixels.
material MaterialProperty <optional>
 Color.WHITE A Property specifying the material used to draw the path.
resolution Property <optional>
 60 A numeric Property specifying the maximum number of seconds to step when sampling the position.
distanceDisplayCondition Property <optional>
 A Property specifying at what distance from the camera that this path will be displayed.
Source:

Members

(readonly) definitionChanged :Event

Gets the event that is raised whenever a property or sub-property is changed or modified.
Type:
Source:

distanceDisplayCondition :Property

Gets or sets the DistanceDisplayCondition Property specifying at what distance from the camera that this path will be displayed.
Type:
Source:

leadTime :Property

Gets or sets the Property specifying the number of seconds in front of the object to show.
Type:
Source:

material :MaterialProperty

Gets or sets the Property specifying the material used to draw the path.
Type:
Default Value:
  • Color.WHITE
Source:

resolution :Property

Gets or sets the Property specifying the maximum number of seconds to step when sampling the position.
Type:
Default Value:
  • 60
Source:

show :Property

Gets or sets the boolean Property specifying the visibility of the path.
Type:
Default Value:
  • true
Source:

trailTime :Property

Gets or sets the Property specifying the number of seconds behind the object to show.
Type:
Source:

width :Property

Gets or sets the numeric Property specifying the width in pixels.
Type:
Default Value:
  • 1.0
Source:

Methods

clone(resultopt) → {PathGraphics}

Duplicates this instance.
Parameters:
Name Type Attributes Description
result PathGraphics <optional>
 The object onto which to store the result.
Source:
Returns:
The modified result parameter or a new instance if one was not provided.
Type
PathGraphics

merge(source)

Assigns each unassigned property on this object to the value of the same property on the provided source object.
Parameters:
Name Type Description
source PathGraphics The object to be merged into this object.
Source: