Class Sculpt

Hierarchy

Subscribe<Event>
- Sculpt

Index

Constructors

constructor

new Sculpt(five, theme?): Sculpt
Parameters
- five: Five
- Optional theme: PartialObjectDeep<{
      box: BoxStyle;
      circle: CircleWithEdgeMeshStyle;
      cylinder: CircleWithEdgeMeshStyle;
      point: PointStyle;
      polygon: AreaStyle;
      polyline: LineMeshStyle;
      prism: PrismStyle;
      rectangle: RectangleWithEdgeMeshStyle;
  }, {}>
Returns Sculpt
Overrides Subscribe<Event>.constructor
- Defined in src/Sculpt/index.ts:110

Properties

group

group: IObject3D

`Static` modules

modules: GlobalModules = globalModules

Accessors

data

get data(): {
    items: ({
        id: string;
        points: [number, number, number][];
        style: {
            dashed: boolean;
            lineColor: number;
            lineWidth: number;
        };
        type: string;
    } | {
        id: string;
        point: [number, number, number];
        style: {
            color: number;
            size: number;
        };
        type: string;
    } | {
        id: string;
        points: [number, number, number][];
        style: {
            color: number;
            lineColor: number;
            lineWidth: number;
        };
        type: string;
    } | {
        heightPoint: [number, number, number];
        id: string;
        points: [number, number, number][];
        style: {
            color: number;
            lineColor: number;
            lineWidth: number;
        };
        type: string;
    } | {
        id: string;
        points: [ArrayPosition, ArrayPosition, ArrayPosition];
        style: {
            color: number;
            lineColor: number;
            lineWidth: number;
        };
        type: string;
    } | {
        center: [number, number, number];
        id: string;
        normal: [number, number, number];
        radius: number;
        style: {
            color: number;
        };
        type: string;
    } | {
        bottomCenter: [number, number, number];
        id: string;
        radius: number;
        style: {
            color: number;
        };
        topCenter: [number, number, number];
        type: string;
    })[];
}
Returns {
    items: ({
        id: string;
        points: [number, number, number][];
        style: {
            dashed: boolean;
            lineColor: number;
            lineWidth: number;
        };
        type: string;
    } | {
        id: string;
        point: [number, number, number];
        style: {
            color: number;
            size: number;
        };
        type: string;
    } | {
        id: string;
        points: [number, number, number][];
        style: {
            color: number;
            lineColor: number;
            lineWidth: number;
        };
        type: string;
    } | {
        heightPoint: [number, number, number];
        id: string;
        points: [number, number, number][];
        style: {
            color: number;
            lineColor: number;
            lineWidth: number;
        };
        type: string;
    } | {
        id: string;
        points: [ArrayPosition, ArrayPosition, ArrayPosition];
        style: {
            color: number;
            lineColor: number;
            lineWidth: number;
        };
        type: string;
    } | {
        center: [number, number, number];
        id: string;
        normal: [number, number, number];
        radius: number;
        style: {
            color: number;
        };
        type: string;
    } | {
        bottomCenter: [number, number, number];
        id: string;
        radius: number;
        style: {
            color: number;
        };
        topCenter: [number, number, number];
        type: string;
    })[];
}
- items: ({
      id: string;
      points: [number, number, number][];
      style: {
          dashed: boolean;
          lineColor: number;
          lineWidth: number;
      };
      type: string;
  } | {
      id: string;
      point: [number, number, number];
      style: {
          color: number;
          size: number;
      };
      type: string;
  } | {
      id: string;
      points: [number, number, number][];
      style: {
          color: number;
          lineColor: number;
          lineWidth: number;
      };
      type: string;
  } | {
      heightPoint: [number, number, number];
      id: string;
      points: [number, number, number][];
      style: {
          color: number;
          lineColor: number;
          lineWidth: number;
      };
      type: string;
  } | {
      id: string;
      points: [ArrayPosition, ArrayPosition, ArrayPosition];
      style: {
          color: number;
          lineColor: number;
          lineWidth: number;
      };
      type: string;
  } | {
      center: [number, number, number];
      id: string;
      normal: [number, number, number];
      radius: number;
      style: {
          color: number;
      };
      type: string;
  } | {
      bottomCenter: [number, number, number];
      id: string;
      radius: number;
      style: {
          color: number;
      };
      topCenter: [number, number, number];
      type: string;
  })[]
- Defined in src/Sculpt/index.ts:85

items

get items(): BuiltInItem[]
Returns BuiltInItem[]
- Defined in src/Sculpt/index.ts:102

Methods

clear

clear(): void
@description: 清空数据

Returns void
- Defined in src/Sculpt/index.ts:258

createBox

createBox(params?): Promise<Box>
@description: 开始绘制 Box
Parameters
- Optional params: Partial<BoxStyle>
Returns Promise<Box>
- Defined in src/Sculpt/index.ts:241

createCircle

createCircle(params?): Promise<Circle>
@description: 开始绘制圆形
Parameters
- Optional params: Partial<CircleWithEdgeMeshStyle>
Returns Promise<Circle>
- Defined in src/Sculpt/index.ts:227

createCylinder

createCylinder(params?): Promise<Cylinder>
@description: 开始绘制圆柱
Parameters
- Optional params: Partial<CircleStyle>
Returns Promise<Cylinder>
- Defined in src/Sculpt/index.ts:234

createPoint

createPoint(params?): Promise<Point>
@description: 开始绘制点
Parameters
- Optional params: PointStyle
Returns Promise<Point>
- Defined in src/Sculpt/index.ts:192

createPolygon

createPolygon(params?): Promise<Polygon>
@description: 开始绘制平面多边形
Parameters
- Optional params: Partial<ColoredMeshStyle>
Returns Promise<Polygon>
- Defined in src/Sculpt/index.ts:206

createPolyline

createPolyline(params?): Promise<Polyline>
@description: 开始绘制空间折线
Parameters
- Optional params: {
  color?: Color;
  lineWidth?: number;
  }
  - Optional color?: Color
  - Optional lineWidth?: number
Returns Promise<Polyline>
- Defined in src/Sculpt/index.ts:199

createPrism

createPrism(params?): Promise<Prism>
@description: 开始绘制多棱柱
Parameters
- Optional params: Partial<PrismStyle>
Returns Promise<Prism>
- Defined in src/Sculpt/index.ts:213

createRectangle

createRectangle(params?): Promise<Rectangle>
@description: 开始绘制矩形
Parameters
- Optional params: Partial<RectangleWithEdgeMeshStyle>
Returns Promise<Rectangle>
- Defined in src/Sculpt/index.ts:220

emit

emit<K>(name, ...data): boolean
触发事件
Type Parameters
- K extends "click"
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- Rest ...data: Parameters<Event[K]>
  
  触发事件的数据
Returns boolean
canceled 是否被触发取消
Inherited from Subscribe.emit
- Defined in src/shared-utils/Subscribe.ts:117

getItemById

getItemById(id): BuiltInItem
@description: 获取物体实例
Parameters
- id: string
Returns BuiltInItem
- Defined in src/Sculpt/index.ts:174

hasListener

hasListener(name): boolean
判断是否注册了事件
Parameters
- name: "click"
  
  事件类型
Returns boolean
Inherited from Subscribe.hasListener
- Defined in src/shared-utils/Subscribe.ts:48

load

load(data, config?): void
@description: 加载数据展示
Parameters
- data: Data
- Optional config: Partial<BaseObjectConfig>
Returns void
- Defined in src/Sculpt/index.ts:136

off

off<K>(name?, callback?): void
解除事件

如果 name 不传的话解除对应所有事件如果 name, callback 不传的话解除所有name的所有事件
Type Parameters
- K extends "click"
  
  预设的监听事件名称
Parameters
- Optional name: K
  
  事件类型
- Optional callback: ((...args) => ReturnType<Event[K]>)
  
  事件回调函数
  - - (...args): ReturnType<Event[K]>
    - Parameters
      
      Rest ...args: Parameters<Event[K]>
      
      Returns ReturnType<Event[K]>
Returns void
Inherited from Subscribe.off
- Defined in src/shared-utils/Subscribe.ts:90

on

on<K>(name, callback, once?): (() => void)
注册事件
Type Parameters
- K extends "click"
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- callback: ((...args) => ReturnType<Event[K]>)
  
  事件回调函数
  - - (...args): ReturnType<Event[K]>
    - Parameters
      
      Rest ...args: Parameters<Event[K]>
      
      Returns ReturnType<Event[K]>
- Optional once: boolean
  
  是否只执行一次
Returns (() => void)
解除事件
- - (): void
  - 注册事件
    
    Returns void
    解除事件
Inherited from Subscribe.on
- Defined in src/shared-utils/Subscribe.ts:62

once

once<K>(name, callback): (() => void)
注册事件(是否只执行一次)
Type Parameters
- K extends "click"
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- callback: ((...args) => ReturnType<Event[K]>)
  
  事件回调函数
  - - (...args): ReturnType<Event[K]>
    - Parameters
      
      Rest ...args: Parameters<Event[K]>
      
      Returns ReturnType<Event[K]>
Returns (() => void)
解除事件
- - (): void
  - 注册事件(是否只执行一次)
    
    Returns void
    解除事件
Inherited from Subscribe.once
- Defined in src/shared-utils/Subscribe.ts:77

putObject

putObject(object): Object3DHelperController
@description: 放置物体
Parameters
- object: Object3D
Returns Object3DHelperController
- Defined in src/Sculpt/index.ts:181

redo

redo(): void
@description: 重做

Returns void
- Defined in src/Sculpt/index.ts:253

undo

undo(): void
@description: 撤销

Returns void
- Defined in src/Sculpt/index.ts:248

Class Sculpt

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

five: Five

Optional theme: PartialObjectDeep<{ box: BoxStyle; circle: CircleWithEdgeMeshStyle; cylinder: CircleWithEdgeMeshStyle; point: PointStyle; polygon: AreaStyle; polyline: LineMeshStyle; prism: PrismStyle; rectangle: RectangleWithEdgeMeshStyle; }, {}>

Returns Sculpt

Properties

group

Static modules

Accessors

data

items

Returns BuiltInItem[]

Methods

clear

Returns void

createBox

Parameters

Optional params: Partial<BoxStyle>

Returns Promise<Box>

createCircle

Parameters

Optional params: Partial<CircleWithEdgeMeshStyle>

Returns Promise<Circle>

createCylinder

Parameters

Optional params: Partial<CircleStyle>

Returns Promise<Cylinder>

createPoint

Parameters

Optional params: PointStyle

Returns Promise<Point>

createPolygon

Parameters

Optional params: Partial<ColoredMeshStyle>

Returns Promise<Polygon>

createPolyline

Parameters

Optional params: { color?: Color; lineWidth?: number; }

Optional color?: Color

Optional lineWidth?: number

Returns Promise<Polyline>

createPrism

Parameters

Optional params: Partial<PrismStyle>

Returns Promise<Prism>

createRectangle

Parameters

Optional params: Partial<RectangleWithEdgeMeshStyle>

Returns Promise<Rectangle>

emit

Type Parameters

K extends "click"

Parameters

name: K

Rest ...data: Parameters<Event[K]>

Returns boolean

getItemById

Parameters

id: string

Returns BuiltInItem

hasListener

Parameters

name: "click"

Returns boolean

load

Parameters

data: Data

Optional config: Partial<BaseObjectConfig>

Returns void

off

Type Parameters

K extends "click"

`Optional` theme: PartialObjectDeep<{
box: BoxStyle;
circle: CircleWithEdgeMeshStyle;
cylinder: CircleWithEdgeMeshStyle;
point: PointStyle;
polygon: AreaStyle;
polyline: LineMeshStyle;
prism: PrismStyle;
rectangle: RectangleWithEdgeMeshStyle;
}, {}>

`Static` modules

`Optional` params: Partial<BoxStyle>

`Optional` params: Partial<CircleWithEdgeMeshStyle>

`Optional` params: Partial<CircleStyle>

`Optional` params: PointStyle

`Optional` params: Partial<ColoredMeshStyle>

`Optional` params: {
color?: Color;
lineWidth?: number;
}

`Optional` color?: Color

`Optional` lineWidth?: number

`Optional` params: Partial<PrismStyle>

`Optional` params: Partial<RectangleWithEdgeMeshStyle>

`Rest` ...data: Parameters<Event[K]>

`Optional` config: Partial<BaseObjectConfig>

`Optional` name: K

`Optional` callback: ((...args) => ReturnType<Event[K]>)

`Rest` ...args: Parameters<Event[K]>

`Rest` ...args: Parameters<Event[K]>

`Optional` once: boolean

`Rest` ...args: Parameters<Event[K]>