Class: PointGraphics

PointGraphics

new PointGraphics(optionsopt)

Describes a graphical point located at the position of the containing Entity.
Parameters:
Name Type Attributes Description
options Object <optional>
 Object with the following properties:
Properties
Name Type Attributes Default Description
color Property <optional>
 Color.WHITE A Property specifying the Color of the point.
pixelSize Property <optional>
 1 A numeric Property specifying the size in pixels.
outlineColor Property <optional>
 Color.BLACK A Property specifying the Color of the outline.
outlineWidth Property <optional>
 0 A numeric Property specifying the the outline width in pixels.
show Property <optional>
 true A boolean Property specifying the visibility of the point.
scaleByDistance Property <optional>
 A NearFarScalar Property used to scale the point based on distance.
translucencyByDistance Property <optional>
 A NearFarScalar Property used to set translucency based on distance from the camera.
heightReference Property <optional>
 HeightReference.NONE A Property specifying what the height is relative to.
distanceDisplayCondition Property <optional>
 A Property specifying at what distance from the camera that this point will be displayed.
Source:

Members

color :Property

Gets or sets the Property specifying the Color of the point.
Type:
Default Value:
  • Color.WHITE
Source:

(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 point will be displayed.
Type:
Source:

heightReference :Property

Gets or sets the Property specifying the HeightReference.
Type:
Default Value:
  • HeightReference.NONE
Source:

outlineColor :Property

Gets or sets the Property specifying the Color of the outline.
Type:
Default Value:
  • Color.BLACK
Source:

outlineWidth :Property

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

pixelSize :Property

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

scaleByDistance :Property

Gets or sets the NearFarScalar Property used to scale the point based on distance. If undefined, a constant size is used.
Type:
Source:

show :Property

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

translucencyByDistance :Property

Gets or sets NearFarScalar Property specifying the translucency of the point based on the distance from the camera. A point's translucency will interpolate between the NearFarScalar#nearValue and NearFarScalar#farValue while the camera distance falls within the upper and lower bounds of the specified NearFarScalar#near and NearFarScalar#far. Outside of these ranges the points's translucency remains clamped to the nearest bound.
Type:
Source:

Methods

clone(resultopt) → {PointGraphics}

Duplicates this instance.
Parameters:
Name Type Attributes Description
result PointGraphics <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
PointGraphics

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 PointGraphics The object to be merged into this object.
Source: