Blockbench Reference Docs
    Preparing search index...

    Class SplineMesh

    Index

    Constructors

    constructor

    Properties

    _static allow_mirror_modeling? buttons color display_space export faces icon locked menu mesh name parent? preview_controller radial_resolution radius_multiplier render_mode render_options scene_object selected shading texture title tubular_resolution type uuid all animator? behavior behavior_overrides hasAny hasSelected isParent preview_controller properties selected types uuids

    Accessors

    curves handles position vertice_list vertices

    Methods

    addCurves addHandles addTo addVertices applyHandleModeOnVertex applyTexture createUniqueName cubicBézier extend flip getBézierForCurve getBézierForPoints getBézierNormal getBézierPath getCenter getCurvesOfHandle getCurvesOfPoint getFirstHandle getHandleEuler getHandleOfPoint getLastHandle getLastSelected getParentArray getSaveCopy getSelectedCurves getSelectedHandles getSelectedVertices getSelectionRotation getSize getTexture getTubeGeo getTubeMesh getTypeBehavior getUndoCopy getWorldCenter init isChildOf isSmoothShaded markAsSelected moveVector overwrite refreshTubeFaces remove rename resize roll sanitizeName saveName select setColor showContexMenu showInOutliner sortInBefore transferOrigin unselect updateElement updateShading addBehaviorOverride fromSave registerType

    Constructors

    • Parameters

      • data: any
      • uuid: any

      Returns SplineMesh

    Properties

    _static

    _static: { properties: { curves: {}; faces: {}; handles: {}; vertices: {} } }
    allow_mirror_modeling?: boolean
    buttons: OutlinerToggle[]
    color: number
    display_space: any
    export: boolean
    faces: {}
    icon: string
    locked: boolean
    menu: Menu
    mesh: Mesh<BufferGeometry, Material | Material[]> | Object3D
    name: string
    parent?: OutlinerNode & OutlinerNodeParentTraits | "root"
    preview_controller: NodePreviewController
    radial_resolution: any
    radius_multiplier: any
    render_mode: string
    render_options: { display_space: any; shading: any }
    scene_object: Object3D
    selected: boolean
    shading: string
    texture: boolean
    title: string
    tubular_resolution: any
    type: string
    uuid: string
    all: OutlinerElement[]
    animator?: BoneAnimator
    behavior: {
        has_pivot: boolean;
        marker_color: boolean;
        movable: boolean;
        resizable: boolean;
        rotatable: boolean;
        unique_name: boolean;
    }
    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

    • get curves(): {}

      Returns {}

    • set curves(v: {}): void

      Parameters

      • v: {}

      Returns void

    • get handles(): {}

      Returns {}

    • set handles(v: {}): void

      Parameters

      • v: {}

      Returns void

    • get position(): any

      Returns any

    • get vertice_list(): any[]

      Returns any[]

    • get vertices(): {}

      Returns {}

    • set vertices(v: {}): void

      Parameters

      • v: {}

      Returns void

    Methods

    • Parameters

      • ...curves: any[]

      Returns string[]

    • Parameters

      • ...handles: any[]

      Returns string[]

    • Parameters

      • Optionaltarget: OutlinerNode | "root"

      Returns this

    • Parameters

      • ...vectors: any[]

      Returns string[]

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

      Parameters

      • vkey: any

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

      Returns void

    • Parameters

      • texture: any

      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: Vector3; tangent: Vector3 }

    • Parameters

      • data: any

      Returns this

    • Parameters

      • axis: any
      • center: any

      Returns this

    • Parameters

      • time: any
      • key: any

      Returns { point: Vector3; tangent: Vector3 }

    • Parameters

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

      Returns { point: Vector3; tangent: Vector3 }

    • Parameters

      • tangent: any
      • Optionalup: any

      Returns Vector3

    • Parameters

      • OptionalkeepDoubles: boolean

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

    • Parameters

      • global: any

      Returns number[]

    • Parameters

      • hKey: any

      Returns string[]

    • Parameters

      • vKey: any

      Returns string[]

    • Returns { data: any; key: string }

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

      Parameters

      • hKey: any

        Key of the handle we want the transform of.

      • Optionaleuler: any

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

      Returns { c1: number[]; c2: number[]; combined: any }

    • Parameters

      • vKey: any

      Returns string

    • Returns { data: any; key: string }

    • Returns OutlinerElement

    • Returns {
          curves: {};
          handles: {};
          texture: string;
          type: string;
          uuid: string;
          vertices: {};
      }

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

      Parameters

      • Optionalloose: any

        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: any

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

      Returns string[]

    • Parameters

      • make: any

      Returns any

    • Returns Euler

    • Parameters

      • axis: any
      • selection_only: any

      Returns number

    • Returns number | boolean

    • 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

    • Parameters

      • Optionalaspects: {}

      Returns {
          curves: {};
          handles: {};
          texture: string;
          type: string;
          uuid: string;
          vertices: {};
      }

    • Parameters

      • ignore_mesh_selection: any

      Returns Vector3

    • 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

    • Returns boolean

    • Mark the element as selected

      Parameters

      • Optionaldescendants: boolean

      Returns void

    • Parameters

      • arr: any
      • axis: any
      • Optionalupdate: boolean

      Returns void

    • Parameters

      • data: any

      Returns this

    • 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

    • Parameters

      • axis: any
      • steps: any
      • origin_arg: any

      Returns this

    • 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

    • Parameters

      • index: any

      Returns void

    • 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

    • Parameters

      • origin: any
      • Optionalupdate: boolean

      Returns this

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

      Returns this

    • Parameters

      • shade_smooth: any

      Returns void

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods