Blockbench Reference Docs
    Preparing search index...

    Class SplineMesh

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _static allow_mirror_modeling? children? cyclic display_space export locked menu? name name_regex parent radial_resolution radius_multiplier render_mode render_order scope selected shading tubular_resolution type uuid uv_mode all animator? behavior behavior_overrides isParent preview_controller properties selected types uuids

    Accessors

    curves handles mesh position preview_controller scene_object temp_data vertice_list vertices

    Methods

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

    Constructors

    Properties

    Readonly_static

    _static: { properties: any; temp_data: Record<string, any> }
    allow_mirror_modeling?: boolean
    children?: OutlinerNode[]
    cyclic: boolean
    display_space: boolean
    export: boolean
    locked: boolean
    menu?: Menu
    name: string
    name_regex: (element?: OutlinerNode) => string | boolean
    parent: OutlinerNode & OutlinerNodeParentTraits | "root"
    radial_resolution: number
    radius_multiplier: number
    render_mode: "path" | "mesh"
    render_order: "default" | "behind" | "in_front"
    scope: number
    selected: boolean
    shading: "flat" | "smooth"
    tubular_resolution: number
    type: string
    uuid: string
    uv_mode: "length_accurate" | "uniform" | "per_segment"
    all: OutlinerElement[]
    animator?: BoneAnimator
    behavior: Record<string, any>
    behavior_overrides: any[]
    isParent: false
    preview_controller: NodePreviewController
    properties: Record<string, Property<any>>
    selected: OutlinerElement[]
    types: Record<string, ElementTypeConstructor>
    uuids: { [uuid: string]: OutlinerNode }

    Accessors

    • get mesh(): Object3D

      Returns Object3D

    • get scene_object(): Object3D

      Returns Object3D

    • get temp_data(): Record<string, any>

      Returns Record<string, any>

    Methods

    • Parameters

      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

    • Parameters

      • event: any
      • Optionaloutliner_click: boolean

      Returns void

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

      Parameters

      Returns string | false

    • Parameters

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

      Returns { point: any; tangent: any }

    • Returns OutlinerElement

    • Parameters

      • fc: (element: OutlinerElement) => void
      • Optionalundo_tag: string
      • Optionalselection_method: "all_selected" | "all_in_group"

      Returns OutlinerElement[]

    • Returns OutlinerNode[]

    • 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[];
      }

    • Returns number

    • 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 }

    • Returns OutlinerNode[]

    • 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

    • Parameters

      • toggle: any

      Returns true

    • Mark the element as selected

      Parameters

      • Optionalselect_children: boolean

      Returns this

    • Parameters

      • search_term_lowercase: string

      Returns boolean

    • 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 node.

      Returns this

    • Returns this

    • 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

    • Returns string

    • 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: Event
      • Optionalis_outliner_click: boolean

      Returns false | SplineMesh

    • Displays the context menu of the element

      Parameters

      • event: HTMLElement | Event

        Mouse event, determines where the context menu spawns.

      Returns this

    • Parameters

      • event: MouseEvent

      Returns this

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

      Returns void

    • Parameters

      Returns this

    • Parameters

      • Optionalunselect_parent: boolean

      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: ConditionResolvable;
            priority?: number;
        }

      Returns Deletable

    • Parameters

      • obj: any
      • Optionalkeep_uuid: boolean

      Returns OutlinerElement

    • Check if any elements of the type are in the project

      Returns boolean

    • Check if any elements of the type are currently selected

      Returns boolean

    • Parameters

      • type: string

      Returns boolean

    • Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    addCurvesaddHandlesaddToaddVerticesapplyHandleModeOnVertexapplyTextureclickSelectcreateUniqueNamecubicBézierduplicateextendflipforSelectedgetAllAncestorsgetBézierForCurvegetBézierForPointsgetBézierNormalgetBézierPathgetCentergetCurvesOfHandlegetCurvesOfPointgetDepthgetFirstHandlegetHandleEulergetHandleOfPointgetLastHandlegetLastSelectedgetParentArraygetSaveCopygetSelectedCurvesgetSelectedHandlesgetSelectedVerticesgetSizegetTexturegetTubeGeogetTubeMeshgetTypeBehaviorgetUndoCopygetWorldCenterinitisChildOfisIconEnabledmarkAsSelectedmatchesFiltermoveVectoroverwriterefreshTubeFacesremoveremoveFromParentrenameresizerollsanitizeNamesaveNameselectsetColorshowContexMenushowContextMenushowInOutlinersortInBeforetransferOriginunselectupdateElementupdateShadingaddBehaviorOverridefromSavehasAnyhasSelectedisTypePermittedregisterType