Class InstancedLinesMesh
Hierarchy
-
InstancedMesh
- InstancedLinesMesh
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
Parameters
-
name: string
-
source: LinesMesh
Returns InstancedLinesMesh
-
Properties
instanced BuffersSearch playground for instancedBuffers
Object used to store instanced buffers defined by user
Type declaration
-
[key: string]: any
intersection ThresholdSearch playground for intersectionThreshold
The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray. This margin is expressed in world space coordinates, so its value may vary. Initilized with the intersectionThreshold value of the source LinesMesh
Accessors
_positions
is AnInstance
-
Returns boolean
light Sources
-
Gets the list of lights affecting that mesh
Returns Light[]
material
receive Shadows
-
If the source mesh receives shadows
Returns boolean
rendering Group Id
-
Rendering ground id of the source mesh
Returns number
-
Rendering ground id of the source mesh
Parameters
-
value: number
Returns any
-
skeleton
source Mesh
-
The source mesh of the instance
Returns Mesh
visibility
-
Visibility of the source mesh
Returns number
Methods
_remove Light SourceSearch playground for _removeLightSource
-
Parameters
-
light: Light
-
dispose: boolean
Returns void
-
_resync Light SourceSearch playground for _resyncLightSource
-
Parameters
-
light: Light
Returns void
-
_resync Light SourcesSearch playground for _resyncLightSources
-
Returns void
cloneSearch playground for clone
-
Creates a new InstancedMesh from the current mesh.
- name (string) : the cloned mesh name
- newParent (optional Node) : the optional Node to parent the clone to.
- doNotCloneChildren (optional boolean, default
false
) : iftrue
the model children aren't cloned.
Returns the clone.
Parameters
Returns InstancedMesh
create InstanceSearch playground for createInstance
-
Creates a new InstancedMesh object from the mesh model.
Parameters
-
name: string
defines the name of the new instance
Returns InstancedMesh
a new InstancedMesh
-
disposeSearch playground for dispose
-
Disposes the InstancedMesh. Returns nothing.
Parameters
-
Optional doNotRecurse: boolean
-
Optional disposeMaterialAndTextures: boolean
Returns void
-
enable Edges RenderingSearch playground for enableEdgesRendering
-
Enables the edge rendering mode on the mesh. This mode makes the mesh edges visible
Parameters
-
Optional epsilon: number
defines the maximal distance between two angles to detect a face
-
Optional checkVerticesInsteadOfIndices: boolean
indicates that we should check vertex list directly instead of faces
Returns InstancedLinesMesh
the current InstancedLinesMesh
-
get Class NameSearch playground for getClassName
-
Returns the string "InstancedLinesMesh".
Returns string
get IndicesSearch playground for getIndices
-
Returns an array of indices (IndicesArray).
Returns Nullable<IndicesArray>
getLODSearch playground for getLOD
-
Returns the current associated LOD AbstractMesh.
Parameters
-
camera: Camera
Returns AbstractMesh
-
get Total IndicesSearch playground for getTotalIndices
-
Returns a positive integer : the total number of indices in this mesh geometry.
Returns number
the numner of indices or zero if the mesh has no geometry.
get Total VerticesSearch playground for getTotalVertices
-
Returns the total number of vertices (integer).
Returns number
get Vertices DataSearch playground for getVerticesData
-
Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
Parameters
-
kind: string
kind of verticies to retreive (eg. positons, normals, uvs, etc.)
-
Optional copyWhenShared: boolean
If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
Returns Nullable<FloatArray>
a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
-
get World MatrixSearch playground for getWorldMatrix
-
Returns Matrix
is ReadySearch playground for isReady
-
Is this node ready to be used/rendered
Parameters
-
Optional completeCheck: boolean
defines if a complete check (including materials and lights) has to be done (false by default)
Returns boolean
is it ready
-
is Vertices Data PresentSearch playground for isVerticesDataPresent
-
Boolean : True if the mesh owns the requested kind of data.
Parameters
-
kind: string
Returns boolean
-
refresh Bounding InfoSearch playground for refreshBoundingInfo
-
This method recomputes and sets a new BoundingInfo to the mesh unless it is locked. This means the mesh underlying bounding box and sphere are recomputed.
Parameters
-
Optional applySkeleton: boolean
defines whether to apply the skeleton before computing the bounding info
Returns InstancedMesh
the current mesh
-
set IndicesSearch playground for setIndices
-
Sets the mesh indices. Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array). If the mesh has no geometry, a new Geometry object is created and set to the mesh. This method creates a new index buffer each call. Returns the Mesh.
Parameters
-
indices: IndicesArray
-
Optional totalVertices: Nullable<number>
Returns Mesh
-
set Vertices DataSearch playground for setVerticesData
-
Sets the vertex data of the mesh geometry for the requested
kind
. If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data. Thedata
are either a numeric array either a Float32Array. The parameterupdatable
is passed as is to the underlying Geometry object constructor (if initianilly none) or updater. The parameterstride
is an optional positive integer, it is usually automatically deducted from thekind
(3 for positions or normals, 2 for UV, etc). Note that a new underlying VertexBuffer object is created each call. If thekind
is thePositionKind
, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.Possible
kind
values :- VertexBuffer.PositionKind
- VertexBuffer.UVKind
- VertexBuffer.UV2Kind
- VertexBuffer.UV3Kind
- VertexBuffer.UV4Kind
- VertexBuffer.UV5Kind
- VertexBuffer.UV6Kind
- VertexBuffer.ColorKind
- VertexBuffer.MatricesIndicesKind
- VertexBuffer.MatricesIndicesExtraKind
- VertexBuffer.MatricesWeightsKind
- VertexBuffer.MatricesWeightsExtraKind
Returns the Mesh.
Parameters
-
kind: string
-
data: FloatArray
-
Optional updatable: boolean
-
Optional stride: number
Returns AbstractMesh
update Vertices DataSearch playground for updateVerticesData
-
Updates the existing vertex data of the mesh geometry for the requested
kind
. If the mesh has no geometry, it is simply returned as it is. Thedata
are either a numeric array either a Float32Array. No new underlying VertexBuffer object is created. If thekind
is thePositionKind
and ifupdateExtends
is true, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed. If the parametermakeItUnique
is true, a new global geometry is created from this positions and is set to the mesh.Possible
kind
values :- VertexBuffer.PositionKind
- VertexBuffer.UVKind
- VertexBuffer.UV2Kind
- VertexBuffer.UV3Kind
- VertexBuffer.UV4Kind
- VertexBuffer.UV5Kind
- VertexBuffer.UV6Kind
- VertexBuffer.ColorKind
- VertexBuffer.MatricesIndicesKind
- VertexBuffer.MatricesIndicesExtraKind
- VertexBuffer.MatricesWeightsKind
- VertexBuffer.MatricesWeightsExtraKind
Returns the Mesh.
Parameters
-
kind: string
-
data: FloatArray
-
Optional updateExtends: boolean
-
Optional makeItUnique: boolean
Returns Mesh
Creates an instance based on a source LinesMesh