Interface IGeometry<Attributes, TE>

interface IGeometry<
    Attributes extends NormalOrGLBufferAttributes = NormalBufferAttributes,
    TE extends IGeometryEventMap = IGeometryEventMap,
> {
    _uiConfig?: UiObjectConfig<any, string, any>;
    appliedMeshes: Set<IObject3D<IObject3DEventMap>>;
    assetType: "geometry";
    uiConfig?: UiObjectConfig<any, string, any>;
    userData: IGeometryUserData;
    center(
        offset?: Vector3,
        keepWorldPosition?: boolean,
        setDirty?: boolean,
    ): BufferGeometry;
    center2(offset?: Vector3, keepWorldPosition?: boolean): () => void;
    dispose(force?: boolean): void;
    refreshUi(): void;
    setDirty(options?: IGeometrySetDirtyOptions): void;
}

Type Parameters

Attributes extends NormalOrGLBufferAttributes = NormalBufferAttributes
TE extends IGeometryEventMap = IGeometryEventMap

Hierarchy

BufferGeometry<Attributes, TE>
IUiConfigContainer
- IGeometry

Implemented by

Index

Properties

_uiConfig? appliedMeshes assetType uiConfig? userData

Methods

center center2 dispose refreshUi setDirty

Properties

`Optional`_uiConfig

_uiConfig?: UiObjectConfig<any, string, any>

appliedMeshes

appliedMeshes: Set<IObject3D<IObject3DEventMap>>

assetType

assetType: "geometry"

`Optional`uiConfig

uiConfig?: UiObjectConfig<any, string, any>

userData

userData: IGeometryUserData

An object that can be used to store custom data about the BufferGeometry. It should not hold references to functions as these will not be cloned.

Default Value

{}

Methods

center

center(
    offset?: Vector3,
    keepWorldPosition?: boolean,
    setDirty?: boolean,
): BufferGeometry
Centers the geometry.
Parameters
- Optionaloffset: Vector3
  returns the offset applied to the geometry
- OptionalkeepWorldPosition: boolean
  Updates the attached meshes, so that the world position of the geometry remains the same.
- OptionalsetDirty: boolean
Returns BufferGeometry
Overrides BufferGeometry.center
- Defined in src/core/IGeometry.ts:34

center2

center2(offset?: Vector3, keepWorldPosition?: boolean): () => void
Same as center but returns a function to undo the centering
Parameters
- Optionaloffset: Vector3
- OptionalkeepWorldPosition: boolean
Returns () => void
- Defined in src/core/IGeometry.ts:41

dispose

dispose(force?: boolean): void
Disposes the geometry from the GPU. Set force to false if not sure the geometry is used by any object in the scene. // todo add check for visible in scene also? or is that overkill
Parameters
- Optionalforce: boolean
  when true, same as three.js dispose. when false, only disposes if disposeOnIdle not false and not used by any object in the scene. default: true
Returns void
Overrides BufferGeometry.dispose
- Defined in src/core/IGeometry.ts:52

refreshUi

refreshUi(): void
Returns void
- Defined in src/core/IGeometry.ts:24

setDirty

setDirty(options?: IGeometrySetDirtyOptions): void
Parameters
- Optionaloptions: IGeometrySetDirtyOptions
Returns void
- Defined in src/core/IGeometry.ts:23