Class CylinderMesh

Hierarchy

IObject3D
- CylinderMesh

Index

Constructors

Properties

bottomCircle name needsRender topCircle

Accessors

bottomCenter color normal radius topCenter

Methods

add addIfNotExists highlight remove removeChildren removeFromParent setBottomCenter setPoints setStyle setTopCenter unhighlight

Constructors

constructor

new CylinderMesh(params?): CylinderMesh
Parameters
- Optionalparams: Partial<OpacityStyle & ColorStyle & OcclusionStyle & LineColorStyle & LineOpacityStyle & LineWidthStyle & CylinderData>
Returns CylinderMesh
Overrides IObject3D.constructor
- Defined in plugins/src/Sculpt/Meshes/Cylinder.ts:53

Properties

bottomCircle

bottomCircle: CircleWithEdgeMesh

name

name: string = 'IObject3D'

Optional name of the object (doesn't need to be unique).

needsRender

needsRender: boolean

topCircle

topCircle: CircleWithEdgeMesh

Accessors

bottomCenter

get bottomCenter(): Vector3
Returns Vector3
- Defined in plugins/src/Sculpt/Meshes/Cylinder.ts:21

color

get color(): Color
Returns Color
- Defined in plugins/src/Sculpt/Meshes/Cylinder.ts:37

normal

get normal(): Vector3
Returns Vector3
- Defined in plugins/src/Sculpt/Meshes/Cylinder.ts:29

radius

get radius(): number
Returns number
- Defined in plugins/src/Sculpt/Meshes/Cylinder.ts:33

topCenter

get topCenter(): Vector3
Returns Vector3
- Defined in plugins/src/Sculpt/Meshes/Cylinder.ts:25

Methods

add

add(...objects): CylinderMesh
Adds object as child of this object.
Parameters
- Rest...objects: Object3D[]
Returns CylinderMesh
Inherited from IObject3D.add
- Defined in plugins/src/shared-utils/three/IObject3D.ts:18

addIfNotExists

addIfNotExists(...objects): CylinderMesh
Parameters
- Rest...objects: Object3D[]
Returns CylinderMesh
Inherited from IObject3D.addIfNotExists
- Defined in plugins/src/shared-utils/three/IObject3D.ts:24

highlight

highlight(): void
Returns void
- Defined in plugins/src/Sculpt/Meshes/Cylinder.ts:107

remove

remove(...objects): CylinderMesh
Removes object as child of this object.
Parameters
- Rest...objects: Object3D[]
Returns CylinderMesh
Inherited from IObject3D.remove
- Defined in plugins/src/shared-utils/three/IObject3D.ts:32

removeChildren

removeChildren(): CylinderMesh
Returns CylinderMesh
Inherited from IObject3D.removeChildren
- Defined in plugins/src/shared-utils/three/IObject3D.ts:11

removeFromParent

removeFromParent(): CylinderMesh
Returns CylinderMesh
Inherited from IObject3D.removeFromParent
- Defined in plugins/src/shared-utils/three/IObject3D.ts:38

setBottomCenter

setBottomCenter(center): void
Parameters
- center: Vector3
Returns void
- Defined in plugins/src/Sculpt/Meshes/Cylinder.ts:93

setPoints

setPoints(params): void
Parameters
- params: Partial<CylinderData>
Returns void
- Defined in plugins/src/Sculpt/Meshes/Cylinder.ts:71

setStyle

setStyle(style): void
Parameters
- style: Partial<CircleWithEdgeMeshStyle>
Returns void
- Defined in plugins/src/Sculpt/Meshes/Cylinder.ts:101

setTopCenter

setTopCenter(center): void
Parameters
- center: Vector3
Returns void
- Defined in plugins/src/Sculpt/Meshes/Cylinder.ts:85

unhighlight

unhighlight(): void
Returns void
- Defined in plugins/src/Sculpt/Meshes/Cylinder.ts:116