openspace.gaia

Functions overview

Name	Documentation
addClippingBox	Creates a clipping box for a specific Gaia dataset, that can be used to filter out stars that are outside of the box
addClippingSphere	Creates a clipping sphere for a specific Gaia dataset, that can be used to filter out stars that are outside of the sphere
removeClippingBox	Remove any added clipping box
removeClippingSphere	Remove any added clipping sphere

Functions

addClippingBox

Creates a clipping box for a specific Gaia dataset, that can be used to filter out stars that are outside of the box. The box is visualized as a grid in the scene.

Note that only one clipping box can be active at a time. If a new box is added, the old one will be removed.

Parameters

• identifier String

  • The identifier of the scene graph node with a RenderableGaiaStars to be filtered

• size vec3

  • The size of each dimension of the box, in Kiloparsec

• position vec3

  • The position of the center of the box, specified in galactic coordinates in Kiloparsec

Return type: void

Signature

openspace.gaia.addClippingBox(identifier, size, position)

---

addClippingSphere

Creates a clipping sphere for a specific Gaia dataset, that can be used to filter out stars that are outside of the sphere. The sphere is visualized as a grid in the scene.

Note that only one clipping sphere can be active at a time. If a new one is added, the old one will be removed.

Parameters

• identifier String

  • The identifier of the scene graph node with a RenderableGaiaStars to be filtered

• radius Number

  • The desired radius outside of the clipping sphere, in Kiloparsec

Return type: void

Signature

openspace.gaia.addClippingSphere(identifier, radius)

---

removeClippingBox

Remove any added clipping box.

Return type: void

Signature

openspace.gaia.removeClippingBox()

---

removeClippingSphere

Remove any added clipping sphere.

Return type: void

Signature

openspace.gaia.removeClippingSphere()