API
API|
@babylonjs/core|
CloudPoint

Class CloudPoint

Represents one particle of a points cloud system.

Index
constructor
_group color groupId idx idxInGroup parentId pivot position rotation rotationQuaternion translateFromPivot uv velocity
quaternion size
intersectsMesh

  • Creates a Point Cloud object. Don't create particles manually, use instead the PCS internal tools like _addParticle()

    Parameters

    • particleIndex: number

      (integer) is the particle index in the PCS pool. It's also the particle identifier.

    • group: PointsGroup

      (PointsGroup) is the group the particle belongs to

    • groupId: number

      (integer) is the group identifier in the PCS.

    • idxInGroup: number

      (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))

    • pcs: PointsCloudSystem

      defines the PCS it is associated to

    Returns CloudPoint

_group

_group: PointsGroup

Group this particle belongs to

color: Nullable<Color4> = ...

The color of the particle

groupId: number = 0

Group id of this particle

idx: number = 0

particle global index

idxInGroup: number = 0

Index of the particle in its group id (Internal use)

parentId: Nullable<number> = null

Parent particle Id, if any. Default null.

pivot: Vector3 = ...

The pivot point in the particle local space.

position: Vector3 = ...

The world space position of the particle.

rotation: Vector3 = ...

The world space rotation of the particle. (Not use if rotationQuaternion is set)

rotationQuaternion: Nullable<Quaternion>

The world space rotation quaternion of the particle.

translateFromPivot: boolean = false

Must the particle be translated from its pivot point in its local space ? In this case, the pivot point is set at the origin of the particle local space and the particle is translated. Default : false

uv: Nullable<Vector2> = ...

The uv of the particle.

velocity: Vector3 = ...

The current speed of the particle.

  • Returns a boolean. True if the particle intersects a mesh, else false The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere

    Parameters

    • target: Mesh

      is the object (point or mesh) what the intersection is computed against

    • isSphere: boolean

      is boolean flag when false (default) bounding box of mesh is used, when true the bounding sphere is used

    Returns boolean

    true if it intersects