Blockbench Reference Docs
    Preparing search index...
    Index

    Constructors

    Properties

    allow_mirror_modeling?: boolean
    cyclic: boolean
    display_space: boolean
    export: boolean
    locked: boolean
    menu?: Menu
    mesh: Mesh<BufferGeometry, Material | Material[]> | Object3D
    name: string
    parent?: OutlinerNode & OutlinerNodeParentTraits | "root"
    preview_controller: NodePreviewController
    radial_resolution: number
    radius_multiplier: number
    render_mode: "path" | "mesh"
    render_order: "default" | "behind" | "in_front"
    scene_object: Object3D
    selected: boolean
    shading: "flat" | "smooth"
    tubular_resolution: number
    type: string
    uuid: string
    uv_mode: "length_accurate" | "uniform" | "per_segment"
    all: OutlinerElement[]
    animator?: BoneAnimator
    behavior_overrides: any[] = []
    hasAny: () => boolean

    Check if any elements of the type are in the project

    hasSelected: () => boolean

    Check if any elements of the type are currently selected

    isParent: false
    preview_controller: NodePreviewController
    properties: Record<string, Property<any>>
    selected: OutlinerElement[]
    types: Record<string, typeof OutlinerElement>
    uuids: { [uuid: string]: OutlinerNode }

    Accessors

    Methods

    • Parameters

      • Optionaltarget: OutlinerNode | "root"

      Returns this

    • Applies the effects of Handle selection mode to the sibling vertex of this vKey. (Mirrored or Aligned)

      Parameters

      • vkey: string

        The Key of the reference vertex, from which the result will be copied over to its sibling (if applicable).

      Returns void

    • Create a unique name for the group or element by adding a number at the end or increasing it.

      Parameters

      • Optionalothers: OutlinerNode[]

      Returns this

    • Parameters

      • time: any
      • point1: any
      • point2: any
      • point3: any
      • point4: any

      Returns { point: any; tangent: any }

    • Parameters

      • time: any
      • key: string

      Returns { point: any; tangent: any }

    • Parameters

      • time: any
      • p1k: any
      • p2k: any
      • p3k: any
      • p4k: any

      Returns { point: any; tangent: any }

    • Parameters

      • OptionalkeepDoubles: boolean

      Returns {
          accumulatedLengths: number[];
          connections: boolean[];
          lengths: any[];
          normals: any[];
          pathLength: number;
          points: any[];
          sizes: any[];
          tangents: any[];
      }

    • Gather control point transform data, primarily to orient the handleGizmos correctly, but also for normal transform space.

      Parameters

      • hKey: string

        Key of the handle we want the transform of.

      • Optionaleuler: Euler

        re-orientation Euler in case we need to re-orient the result of this to match another direction.

      Returns { c1: any; c2: any; combined: any }

    • Readonly list of selected curves, based on selected handles. See () for handle selection.

      Parameters

      • Optionalloose: boolean

        Tells the handle selection if it should count controls being selected without their joint.

      Returns string[]

    • Readonly list of selected handles, based on selected vertices.

      Parameters

      • Optionalloose: boolean

        Tells the handle selection if it should count controls being selected without their joint.

      Returns string[]

    • Parameters

      • shadeSmooth: any

      Returns { indices: number[]; normals: any[]; uvs: number[]; vertices: any[] }

    • Parameters

      • OptionalremoveDoubles: boolean
      • Optionalmesh: { faces: {}; vertices: {} }

      Returns { faces: {}; vertices: {} }

    • Parameters

      • flag: string

      Returns any

    • Initializes the node. This should always be called when creating nodes that will be used in the outliner.

      Returns this

    • Checks of the group or element is a child of group.

      Parameters

      • node: OutlinerNode
      • max_levels: number

        The maximum number of generations that can be between the element and the group

      Returns boolean

    • Mark the element as selected

      Parameters

      • Optionaldescendants: boolean

      Returns void

    • Refresh the dummy face object of this spline, allowing us to paint on it, or to convert it to a Mesh.

      Returns void

    • Removes the element.

      Parameters

      • Optionalundo: boolean

      Returns void

    • Marks the name of the group or element in the outliner for renaming.

      Returns this

    • Parameters

      • val: any
      • axis: any
      • negative: any
      • allow_negative: any
      • bidirectional: any

      Returns void

    • Saves the changed name of the element by creating an undo point and making the name unique if necessary.

      Parameters

      • Optionalsave: boolean

      Returns this

    • Parameters

      • Optionalevent: any
      • OptionalisOutlinerClick: boolean

      Returns this

    • Displays the context menu of the element

      Parameters

      • event: Event | HTMLElement

        Mouse event, determines where the context menu spawns.

      Returns this

    • Unfolds the outliner and scrolls up or down if necessary to show the group or element.

      Returns this

    • Parameters

      • Optionaltarget: OutlinerNode
      • Optionalindex_modifier: number

      Returns this

    • Updates the Vue node of the element. This is only necessary in some rare situations

      Returns this

    • Parameters

      • override_options: { behavior: Record<string, any>; condition: any }

      Returns Deletable

    • Parameters

      • data: any
      • Optionalkeep_uuid: boolean

      Returns OutlinerElement

    • Parameters

      • constructor: any
      • id: string

      Returns void