@wendylabsinc/react-three-mesh-editor - v0.0.1
    Preparing search index...

    Interface MeshEditorProps

    Props for the MeshEditor component.

    interface MeshEditorProps {
        defaultEdgeColor?: string;
        defaultFaceColor?: string;
        defaultVertexColor?: string;
        edgeLineWidth?: number;
        editMode?: EditMode;
        editor?: UseMeshEditorReturn;
        geometry: BufferGeometry;
        hoverColor?: string;
        mode?: EditorMode;
        onEditModeChange?: (editMode: EditMode) => void;
        onGeometryChange?: (geometry: BufferGeometry) => void;
        onModeChange?: (mode: EditorMode) => void;
        outlineColor?: string;
        outlineThickness?: number;
        overlayColor?: string;
        renderEdgeControl?: (props: EdgeControlRenderProps) => ReactNode;
        renderFaceControl?: (props: FaceControlRenderProps) => ReactNode;
        renderVertexControl?: (props: VertexControlRenderProps) => ReactNode;
        selected?: boolean;
        selectedColor?: string;
        showOutline?: boolean;
        transparentOpacity?: number;
        vertexSize?: number;
        wireframeColor?: string;
    }
    Index

    Properties

    defaultEdgeColor? defaultFaceColor? defaultVertexColor? edgeLineWidth? editMode? editor? geometry hoverColor? mode? onEditModeChange? onGeometryChange? onModeChange? outlineColor? outlineThickness? overlayColor? renderEdgeControl? renderFaceControl? renderVertexControl? selected? selectedColor? showOutline? transparentOpacity? vertexSize? wireframeColor?

    Properties

    defaultEdgeColor?: string

    Default color of unselected edges

    '#ffffff'
    defaultFaceColor?: string

    Default color of unselected faces

    '#4a90d9'
    defaultVertexColor?: string

    Default color of unselected vertices

    '#4a90d9'
    edgeLineWidth?: number

    Width of edge lines in pixels

    2
    editMode?: EditMode

    Current edit sub-mode. When provided, component is controlled.

    editor?: UseMeshEditorReturn

    External editor instance for controlled mode. When provided, the component uses this editor instead of creating its own. This is useful for accessing editor methods like extrudeFace from parent components.

    geometry: BufferGeometry

    The Three.js BufferGeometry to edit (modified by reference)

    hoverColor?: string

    Color of hovered elements

    '#7bb3e0'
    mode?: EditorMode

    Current editor mode. When provided, component is controlled.

    onEditModeChange?: (editMode: EditMode) => void

    Callback fired when edit mode changes (for controlled usage)

    onGeometryChange?: (geometry: BufferGeometry) => void

    Callback fired when geometry vertices are modified

    onModeChange?: (mode: EditorMode) => void

    Callback fired when mode changes (for controlled usage)

    outlineColor?: string

    Color of the selection outline (defaults to selectedColor)

    outlineThickness?: number

    Thickness of the selection outline

    0.03
    overlayColor?: string

    Color of the mesh overlay in edit mode

    '#6699cc'
    renderEdgeControl?: (props: EdgeControlRenderProps) => ReactNode

    Render function for custom edge controls. Supports translation, rotation, and scale.

    renderFaceControl?: (props: FaceControlRenderProps) => ReactNode

    Render function for custom face controls. Supports translation, rotation, and scale.

    renderVertexControl?: (props: VertexControlRenderProps) => ReactNode

    Render function for custom vertex controls. For vertices, only translation makes sense (no rotation/scale).

    selected?: boolean

    Whether the object is selected (shows outline in object mode)

    false
    selectedColor?: string

    Color of selected elements

    '#ff6b00'
    showOutline?: boolean

    Whether to show the selection outline

    true
    transparentOpacity?: number

    Opacity of semi-transparent elements

    0.3
    vertexSize?: number

    Size of vertex handle cubes in world units

    0.05
    wireframeColor?: string

    Color of the wireframe in edit mode

    '#ffffff'

    Settings

    Member Visibility

    On This Page

    Properties