Class Line

A geometric shape class for creating line primitives with optional terminal markers. Extends IShape to provide line-specific geometry generation capabilities.

Hierarchy (view full)

Constructors

constructor

Properties

_prevMaterial _sortkey _tags _viewDepth InvalidObjectUID currentMaxObjectCount

Accessors

AABB _vertexHandles attributeAccessors attributeComponentTypes attributeCompositionTypes attributeEntries attributeSemantics indicesAccessor material mesh objectUID positionAccessorVersion primitiveMode primitiveUid targets uniqueName vertexHandles variantUpdateCount

Methods

_backupMaterial _belongToMesh _copyFrom _getFingerPrint _restoreMaterial applyMaterialVariant calcFingerPrint castRay convertToUnindexedGeometry copyVertexData create3DAPIVertexData delete3DAPIVertexData generate getAttribute getBlendShapeTargets getCurrentVariantName getIndexBitSize getTag getTagValue getTriangleCountAsIndicesBased getTriangleCountAsVerticesBased getVariantMaterial getVariantNames getVertexCountAsIndicesBased getVertexCountAsVerticesBased hasIndices hasTag isBlend isOpaque matchTag matchTags matchTagsAsFreeStrings onAccessorUpdated removeIndices removeTag setBlendShapeTargets setData setIndices setMaterialVariant setSortKey setVertexAttribute tryToSetTag tryToSetUniqueName unregister update3DAPIVertexData validateTagString _reset createPrimitive getPrimitive getPrimitiveCount getPrimitiveHasMorph getPrimitiveIdxHasMorph getRnObject getRnObjectByName searchByTag

Constructors

constructor

Properties

_prevMaterial

_prevMaterial: WeakRef<Material>

_sortkey

_sortkey: number = 0

_tags

_tags: RnTags = {}

Collection of tags associated with this object

_viewDepth

_viewDepth: number = 0

Static ReadonlyInvalidObjectUID

InvalidObjectUID: -1 = -1

Invalid object UID constant

StaticcurrentMaxObjectCount

currentMaxObjectCount: number = 0

Current maximum object count for UID generation

Accessors

AABB

  • get AABB(): AABB

  • Gets the axis-aligned bounding box for this primitive. The AABB is calculated from position data and cached until positions change.

    Returns AABB

    The bounding box containing all vertices

_vertexHandles

attributeAccessors

attributeComponentTypes

attributeCompositionTypes

attributeEntries

attributeSemantics

indicesAccessor

material

  • get material(): Material

  • Gets the current material assigned to this primitive.

    Returns Material

    The material currently in use

  • set material(mat): void

  • Sets the material for this primitive and updates rendering sort keys. The sort key is updated based on material properties for efficient rendering order.

    Parameters

    • mat: Material

      The material to assign to this primitive

    Returns void

mesh

objectUID

  • get objectUID(): number

  • Gets the unique object identifier

    Returns number

    The object's UID

positionAccessorVersion

  • get positionAccessorVersion(): number

  • Gets the version number of the position accessor. Used to track when position data has been updated.

    Returns number

    The current position accessor version

primitiveMode

primitiveUid

  • get primitiveUid(): number

  • Gets the unique identifier for this primitive.

    Returns number

    The primitive's UID

targets

uniqueName

  • get uniqueName(): string

  • Gets the unique name of this object

    Returns string

    The unique name string

vertexHandles

StaticvariantUpdateCount

  • get variantUpdateCount(): number

  • Gets the current count of material variant updates across all primitives. This counter is incremented whenever material variants are modified.

    Returns number

    The number of material variant updates since application start

Methods

_backupMaterial

_belongToMesh

  • _belongToMesh(mesh): void
  • Internal

    Associates this primitive with a parent mesh. This establishes the hierarchical relationship between mesh and primitive.

    Parameters

    • mesh: Mesh

      The mesh that this primitive belongs to

    Returns void

_copyFrom

_getFingerPrint

_restoreMaterial

applyMaterialVariant

  • applyMaterialVariant(variantName): void

  • Applies a previously registered material variant by its name. Changes the current material to the variant if it exists.

    Parameters

    • variantName: string

      The name of the variant to apply

    Returns void

calcFingerPrint

  • calcFingerPrint(): void

  • Calculates a unique fingerprint string for the primitive based on its properties. The fingerprint includes mode, indices, targets, and attributes configuration. This is used for efficient primitive comparison and caching.

    Returns void

castRay

  • castRay(origVec3, dirVec3, isFrontFacePickable, isBackFacePickable, dotThreshold, hasFaceNormal): RaycastResultEx1

  • Performs ray casting against this primitive's geometry. Tests intersection between a ray and the triangles of this primitive.

    Parameters

    • origVec3: IVector3

      The origin point of the ray

    • dirVec3: IVector3

      The direction vector of the ray (should be normalized)

    • isFrontFacePickable: boolean

      Whether front-facing triangles can be hit

    • isBackFacePickable: boolean

      Whether back-facing triangles can be hit

    • dotThreshold: number

      Threshold for determining front/back face orientation

    • hasFaceNormal: boolean

      Whether to use face normals for culling

    Returns RaycastResultEx1

    Ray casting result with intersection data or failure indication

convertToUnindexedGeometry

copyVertexData

create3DAPIVertexData

  • create3DAPIVertexData(): boolean

  • Creates GPU vertex and index buffers for this primitive. This prepares the primitive for rendering by uploading data to the GPU.

    Returns boolean

    True if buffers were created, false if they already exist

delete3DAPIVertexData

generate

  • generate(_desc): void

  • Generates a line geometry with optional terminal markers at both endpoints. Creates a line between two points with small cross-shaped markers to indicate the start and end positions when hasTerminalMark is enabled.

    Parameters

    Returns void

    Example

    const line = new Line();
    line.generate({
      startPos: Vector3.fromCopy3(0, 0, 0),
      endPos: Vector3.fromCopy3(5, 0, 0),
      hasTerminalMark: true,
      material: myMaterial
    });

getAttribute

getBlendShapeTargets

getCurrentVariantName

getIndexBitSize

  • getIndexBitSize(): "uint16" | "uint32"

  • Determines the bit size required for indices based on the index accessor type.

    Returns "uint16" | "uint32"

    'uint16' for unsigned short/byte indices, 'uint32' for unsigned int indices

    Throws

    Error if no index accessor exists or the component type is unsupported

getTag

  • getTag(tagName): Tag

  • Retrieves a complete tag object (name and value) for the specified tag name

    Parameters

    • tagName: string

      The name of the tag to retrieve

    Returns Tag

    A Tag object containing the name and value

getTagValue

  • getTagValue(tagName): any

  • Retrieves the value associated with a specific tag name

    Parameters

    • tagName: string

      The name of the tag whose value to retrieve

    Returns any

    The tag value, or undefined if the tag doesn't exist

getTriangleCountAsIndicesBased

getTriangleCountAsVerticesBased

getVariantMaterial

getVariantNames

getVertexCountAsIndicesBased

getVertexCountAsVerticesBased

hasIndices

hasTag

  • hasTag(tagName): boolean

  • Checks whether this object has a tag with the specified name

    Parameters

    • tagName: string

      The name of the tag to check for

    Returns boolean

    True if the tag exists (value is not null/undefined), false otherwise

isBlend

isOpaque

matchTag

  • matchTag(tagName, tagValue): boolean

  • Checks if this object has a tag with the specified name and value

    Parameters

    • tagName: string

      The tag name to match

    • tagValue: string

      The tag value to match

    Returns boolean

    True if the object has a matching tag, false otherwise

matchTags

  • matchTags(tags): boolean

  • Checks if this object has all the specified tags with exactly matching values

    Parameters

    • tags: RnTags

      Object containing tag names as keys and expected values

    Returns boolean

    True if all specified tags exist with matching values, false otherwise

matchTagsAsFreeStrings

  • matchTagsAsFreeStrings(stringArray): boolean

  • Checks if the object's combined tag string contains all the provided search strings. This allows for flexible searching within tag names and values.

    Parameters

    • stringArray: string[]

      Array of strings that must all be present in the combined tag string

    Returns boolean

    True if all strings are found in the combined tag string, false otherwise

onAccessorUpdated

  • onAccessorUpdated(accessorVersion): void

  • Notifies the primitive that its position accessor has been updated. This triggers recalculation of bounding boxes and mesh updates.

    Parameters

    • accessorVersion: number

      The new version number of the updated accessor

    Returns void

removeIndices

removeTag

setBlendShapeTargets

setData

  • setData(attributes, mode, material?, indicesAccessor?): void

  • Sets the vertex and index data for this primitive. This is the main method for configuring primitive geometry and rendering properties.

    Parameters

    • attributes: Attributes

      Map of vertex attributes with their semantic meanings

    • mode: PrimitiveModeEnum

      The primitive rendering mode (triangles, triangle strip, etc.)

    • Optionalmaterial: Material

      Optional material to assign (uses default if not provided)

    • OptionalindicesAccessor: Accessor

      Optional index accessor for indexed rendering

    Returns void

setIndices

setMaterialVariant

  • setMaterialVariant(variantName, material): void

  • Registers a material variant for this primitive with a specific name. Material variants allow switching between different materials at runtime.

    Parameters

    • variantName: string

      The unique name for this material variant

    • material: Material

      The material to associate with the variant name

    Returns void

setSortKey

  • setSortKey(offset, length, value): void

  • Updates the sort key by setting a specific bit range with a value. Sort keys are used to optimize rendering order for transparency and material batching.

    Parameters

    • offset: number

      The bit offset position where to start writing

    • length: PrimitiveSortKeyLength

      The number of bits to write

    • value: number

      The value to encode in the specified bit range

    Returns void

setVertexAttribute

tryToSetTag

  • tryToSetTag(tag): boolean

  • Attempts to set a tag on this object. If the tag already exists, it will be replaced.

    Parameters

    • tag: Tag

      The tag object containing the name and value to set

    Returns boolean

    True if the tag was successfully set, false if the tag name contains invalid characters

tryToSetUniqueName

  • tryToSetUniqueName(name, toAddNameIfConflict): boolean

  • Attempts to set a unique name for this object

    Parameters

    • name: string

      The desired unique name

    • toAddNameIfConflict: boolean

      If true, appends UID to make name unique when conflicts occur; if false, fails on conflict

    Returns boolean

    True if the name was successfully set, false if there was a conflict and toAddNameIfConflict was false

unregister

update3DAPIVertexData

  • update3DAPIVertexData(): boolean

  • Updates the GPU vertex and index buffers with current data. Used when vertex data has been modified and needs to be re-uploaded.

    Returns boolean

    True if buffers were updated, false if no buffers exist

validateTagString

  • validateTagString(val): boolean

  • Validates that a tag string contains only allowed characters (alphanumeric and underscore)

    Parameters

    • val: string

      The string to validate

    Returns boolean

    True if the string contains only valid characters, false if it contains invalid characters

Static_reset

StaticcreatePrimitive

StaticgetPrimitive

StaticgetPrimitiveCount

StaticgetPrimitiveHasMorph

StaticgetPrimitiveIdxHasMorph

  • getPrimitiveIdxHasMorph(primitiveUid): undefined | number

  • Gets the index of a primitive with morph targets by its UID.

    Parameters

    • primitiveUid: number

      The unique identifier of the primitive

    Returns undefined | number

    The index if the primitive has morph targets, otherwise undefined

StaticgetRnObject

  • getRnObject(objectUid): undefined | RnObject

  • Retrieves an RnObject instance by its unique identifier

    Parameters

    • objectUid: number

      The unique identifier of the object to retrieve

    Returns undefined | RnObject

    The RnObject instance or undefined if not found or garbage collected

StaticgetRnObjectByName

StaticsearchByTag

  • searchByTag(tag, value): undefined | WeakRef<RnObject>

  • Searches for the first object that has a specific tag with the given value

    Parameters

    • tag: string

      The tag name to search for

    • value: string

      The tag value to match

    Returns undefined | WeakRef<RnObject>

    WeakRef to the first matching object, or undefined if not found

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
_backupMaterial_belongToMesh_copyFrom_getFingerPrint_restoreMaterialapplyMaterialVariantcalcFingerPrintcastRayconvertToUnindexedGeometrycopyVertexDatacreate3DAPIVertexDatadelete3DAPIVertexDatagenerategetAttributegetBlendShapeTargetsgetCurrentVariantNamegetIndexBitSizegetTaggetTagValuegetTriangleCountAsIndicesBasedgetTriangleCountAsVerticesBasedgetVariantMaterialgetVariantNamesgetVertexCountAsIndicesBasedgetVertexCountAsVerticesBasedhasIndiceshasTagisBlendisOpaquematchTagmatchTagsmatchTagsAsFreeStringsonAccessorUpdatedremoveIndicesremoveTagsetBlendShapeTargetssetDatasetIndicessetMaterialVariantsetSortKeysetVertexAttributetryToSetTagtryToSetUniqueNameunregisterupdate3DAPIVertexDatavalidateTagString_resetcreatePrimitivegetPrimitivegetPrimitiveCountgetPrimitiveHasMorphgetPrimitiveIdxHasMorphgetRnObjectgetRnObjectByNamesearchByTag