FatLineBufferGeometry
This is a dedicated geometry for FatLineSegments .
Hierarchy
- InstancedBufferGeometry
- FatLineBufferGeometry
Constructors
constructor
-
Creates an instance of FatLineBufferGeometry. geometry layout must be LineSegment
Parameters
- geometry: BufferGeometry<LineList>
Returns FatLineBufferGeometry
Overrides InstancedBufferGeometry.constructor
Properties
Readonlyuser Data
Inherited from InstancedBufferGeometry.userData
__ topology Mark
Inherited from InstancedBufferGeometry.__topologyMark
name
The name of viewer, which could be empty.
Inherited from InstancedBufferGeometry.name
is Buffer Geometry
Flag to indicate the type of this class. This value should not be changed by user.
Inherited from InstancedBufferGeometry.isBufferGeometry
parameters
This object is used to record all parameters which are set when instance is initialized. But, change the value of this object may not change the geometry directly.
Inherited from InstancedBufferGeometry.parameters
mesh BVH
Use BVH to accelerate rendering. This value usually dose not need you to change it, it is built by the engine automatically.
Inherited from InstancedBufferGeometry.meshBVH
_ indexnull
Allows for vertices to be re-used across multiple triangles; this is called using "indexed triangles".
and works much the same as it does in Geometry: each triangle is associated with the indices of three vertices.
This attribute therefore stores the index of each vertex for each triangular face.
If this attribute is not set, the renderer assumes that each three contiguous positions represent a single triangle.
This should be set by setIndex| setIndex() to avoid error.
Inherited from InstancedBufferGeometry._index
attributes
Core data of Geometry such as vertex positions, normals, UVs and color.
Remarks
See BufferAttribute for more details.
Inherited from InstancedBufferGeometry.attributes
draw Range{ start: 0, count: Infinity }
Determines which part of buffer will be rendered.
Inherited from InstancedBufferGeometry.drawRange
_ uuid
Inherited from InstancedBufferGeometry._uuid
uuid
Inherited from InstancedBufferGeometry.uuid
_ listeners
Inherited from InstancedBufferGeometry._listeners
is Line Segments Geometry
Used to check type of this or extended instance. This value should not be changed by user.
id
Inherited from InstancedBufferGeometry.id
is Instanced Buffer Geometry
Used to check type of this or extended instance. This value should not be changed by user.
Inherited from InstancedBufferGeometry.isInstancedBufferGeometry
type
The type of this instance.
Inherited from InstancedBufferGeometry.type
Accessors
business Tag
-
get businessTag(): string
Returns string
Inherited from InstancedBufferGeometry.businessTag
-
set businessTag(v: string): void
Parameters
- v: string
Returns void
Inherited from InstancedBufferGeometry.businessTag
index
-
get index(): IndexBufferAttribute
Returns IndexBufferAttribute
Inherited from InstancedBufferGeometry.index
-
set index(v: IndexBufferAttribute): void
Parameters
- v: IndexBufferAttribute
Returns void
Inherited from InstancedBufferGeometry.index
position
-
Returns BufferAttribute<TypeArray>
Inherited from InstancedBufferGeometry.position
uv
-
Returns BufferAttribute<TypeArray>
Inherited from InstancedBufferGeometry.uv
fallback
-
Returns BufferGeometry<LineList>
instance Start
-
Returns InstancedBufferAttribute<Float32Array<ArrayBufferLike>>
instance End
-
Returns InstancedBufferAttribute<Float32Array<ArrayBufferLike>>
instanced Count
-
get instancedCount(): number
Returns number
Inherited from InstancedBufferGeometry.instancedCount
-
set instancedCount(v: number): void
Parameters
- v: number
Returns void
Inherited from InstancedBufferGeometry.instancedCount
Methods
mark Business Tag
is Destroyed
-
Returns boolean
Inherited from InstancedBufferGeometry.isDestroyed
validate
-
Returns void
Inherited from InstancedBufferGeometry.validate
get Group
-
get group at index
Parameters
- index: number
Returns BufferGroup | undefined
Inherited from InstancedBufferGeometry.getGroup
set Group
-
Split the data into different groups.
Parameters
- group: BufferGroup
- index: number
Returns void
Inherited from InstancedBufferGeometry.setGroup
set Groups
-
set entire groups
Parameters
- groups: BufferGroup[]
Returns this
Inherited from InstancedBufferGeometry.setGroups
push Group
-
push a group
Parameters
- group: BufferGroup
Returns this
Inherited from InstancedBufferGeometry.pushGroup
add Group
-
Split geometry data to a new group.
Parameters
- start: number
- count: number
- materialIndex: number
Returns void
Inherited from InstancedBufferGeometry.addGroup
clear Groups
-
Clean all objects in the groups| groups.
Returns void
Inherited from InstancedBufferGeometry.clearGroups
get Bounding Box
-
If boundingBox| boundingBox is null, it will be calculated a new one.
Returns Box3
Inherited from InstancedBufferGeometry.getBoundingBox
get Bounding Sphere
-
If boundingSphere| boundingSphere is null, it will be calculated a new one.
Returns Sphere
Inherited from InstancedBufferGeometry.getBoundingSphere
notify Shape Changed
-
Clear the bounding box and sphere and recalculate them later.
Returns void
Inherited from InstancedBufferGeometry.notifyShapeChanged
get Attribute Layout Key
-
Generate a hash key according to index| index and all attributes| attributes.
Returns string
Inherited from InstancedBufferGeometry.getAttributeLayoutKey
class Name
attribute Changed
-
Clean old data of engine and load new data in next update.
Returns void
Inherited from InstancedBufferGeometry.attributeChanged
get Buffer Geometry
-
Return current instance of this class.
Returns this
Inherited from InstancedBufferGeometry.getBufferGeometry
get Line Buffer Geometry
-
Return current instance of this class.
Returns this
Inherited from InstancedBufferGeometry.getLineBufferGeometry
get Index
-
Return the instance of index| index.
Returns IndexBufferAttribute
Inherited from InstancedBufferGeometry.getIndex
on Attribute Update
-
Call this method to let engine refresh data of meshBVH.
Returns void
Inherited from InstancedBufferGeometry.onAttributeUpdate
set Index
-
Use this method to set new index| index for geometry.
Parameters
- index: TypeArray | number[] | IndexBufferAttribute
source data of the index.
Returns this
Inherited from InstancedBufferGeometry.setIndex
- index: TypeArray | number[] | IndexBufferAttribute
add Attribute
-
Parameters
- name: string
- attribute: BufferAttribute
Returns this
Inherited from InstancedBufferGeometry.addAttribute
set Attribute
-
Change the given attributes| attributes for geometry.
Parameters
- name: string
the name of data such as position, uv and normal.
- attribute: BufferAttribute
source data. see BufferAttribute for more details.
Returns this
Inherited from InstancedBufferGeometry.setAttribute
- name: string
add Or Set Attribute
-
Get specified attributes| attributes from geometry.
Parameters
- name: string
the name of target attributes.
- array: TypeArray
- itemSize: number
Returns void
Inherited from InstancedBufferGeometry.addOrSetAttribute
- name: string
get Attribute
-
Parameters
- name: string
Returns BufferAttribute<TypeArray> | undefined
Inherited from InstancedBufferGeometry.getAttribute
remove Attribute
-
Remove specified attributes| attributes from geometry.
Parameters
- name: string
the name of target attributes.
Returns this
Inherited from InstancedBufferGeometry.removeAttribute
- name: string
remove And Destroy Attribute
-
Parameters
- name: string
Returns this
Inherited from InstancedBufferGeometry.removeAndDestroyAttribute
get Group By Vertex Index
-
Find the group which the vertex belong to.
Parameters
- index: number
Queried vertex index.
Returns { group: BufferGroup; groupIndex: number }
Inherited from InstancedBufferGeometry.getGroupByVertexIndex
- index: number
set Draw Range
-
Change the value of drawRange.
Parameters
- start: number
- count: number
Returns void
Inherited from InstancedBufferGeometry.setDrawRange
_ compute Groups
get UUID
-
UUID of this BufferGeometries instance. This gets automatically assigned, so this shouldn't be edited.
Returns string
Inherited from InstancedBufferGeometry.getUUID
serialize
-
Store the attributes of this class into string as serializing format.
Parameters
- ctx: Serializer
this parameter has not supported external Serializer yet. It may cause that this method can not be used directly.
Returns void
Inherited from InstancedBufferGeometry.serialize
- ctx: Serializer
deserialize
-
Parse the data for this class from string according to serializing format.
Parameters
- ctx: Deserializer
this parameter has not supported external Deserializer yet. It may cause that this method can not be used directly.
Returns void
Inherited from InstancedBufferGeometry.deserialize
- ctx: Deserializer
destroy
-
Returns void
Inherited from InstancedBufferGeometry.destroy
destroy Attributes
-
Returns void
Inherited from InstancedBufferGeometry.destroyAttributes
free Attributes Gpu Resource
-
Returns void
Inherited from InstancedBufferGeometry.freeAttributesGpuResource
destroy All Resources Owned
-
Returns void
Inherited from InstancedBufferGeometry.destroyAllResourcesOwned
free All Gpu Resource Owned
-
Returns void
Inherited from InstancedBufferGeometry.freeAllGpuResourceOwned
force Cast Topology
-
Type Parameters
- R extends Topology
Returns BufferGeometry<R>
Inherited from InstancedBufferGeometry.forceCastTopology
on
-
Adds a listener to an event type.
Type Parameters
- T
Returns void
Inherited from InstancedBufferGeometry.on
once
-
Only active the listener one times and then off it| it.
Type Parameters
- T
Returns void
Inherited from InstancedBufferGeometry.once
has
-
Checks if listener is added to an event type.
Type Parameters
- T
Returns boolean
Inherited from InstancedBufferGeometry.has
off
-
Removes a listener from listening list.
Type Parameters
- T
Returns void
Inherited from InstancedBufferGeometry.off
emit
-
Active the event and call the registered listener.
Parameters
- type: EventType<never>
Returns void
Inherited from InstancedBufferGeometry.emit
clear All Listeners
-
Removes all listeners from listening list.
Returns void
Inherited from InstancedBufferGeometry.clearAllListeners
apply Matrix
-
Apply the given matrix to vertexes data.
Parameters
- matrix: Matrix4
Returns FatLineBufferGeometry
this object.
set Positions
-
Build segmented line data by given data and update bounding.
Parameters
- lineSegments: Float32Array
the segments data store as Float32Array.
Returns FatLineBufferGeometry
this object.
- lineSegments: Float32Array
compute Bounding Box
-
Recalculate the bounding box for this geometry.
Returns void
Overrides InstancedBufferGeometry.computeBoundingBox
compute Bounding Sphere
-
Recalculate the bounding sphere for this geometry.
Returns void
Overrides InstancedBufferGeometry.computeBoundingSphere
free GPU
notify Geometry Content Change
-
Returns void
Inherited from InstancedBufferGeometry.notifyGeometryContentChange
copy
-
Copy the data to this object from source. This method need override in derived classes to copy extended data.
Parameters
- source: InstancedBufferGeometry
the data source.
Returns this
Inherited from InstancedBufferGeometry.copy
- source: InstancedBufferGeometry
clone
-
Create a clone of this instance.
Returns InstancedBufferGeometry
Inherited from InstancedBufferGeometry.clone
This is a dedicated geometry for FatLineSegments .