Class IcoSphereBlock

Defines a block used to generate icosphere geometry data

Hierarchy

NodeGeometryBlock
- IcoSphereBlock

Constructors

constructor

new IcoSphereBlock(name: string): IcoSphereBlock

Overrides NodeGeometryBlock.constructor
- Defined in .temp/docdirectory/doc.d.ts:73669
Create a new IcoSphereBlock

Parameters
- name: string
  
  defines the block name
Returns IcoSphereBlock

Properties

comments Search playground for comments

comments: string

A free comment about the block

evaluateContext Search playground for evaluateContext

evaluateContext: boolean

Gets or sets a boolean indicating that this block can evaluate context Build performance is improved when this value is set to false as the system will cache values instead of reevaluating everything per context change

onBuildObservable Search playground for onBuildObservable

onBuildObservable: Observable<NodeGeometryBlock>

Gets an observable raised when the block is built

uniqueId Search playground for uniqueId

uniqueId: number

Gets or sets the unique id of the node

visibleOnFrame Search playground for visibleOnFrame

visibleOnFrame: boolean

Gets or sets a boolean indicating that this input can be edited from a collapsed frame

Accessors

buildExecutionTime

get buildExecutionTime(): number

Inherited from NodeGeometryBlock.buildExecutionTime
- Defined in .temp/docdirectory/doc.d.ts:74570
Gets the time spent to build this block (in ms)

Returns number

geometry

get geometry(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:73698
Gets the geometry output component

Returns NodeGeometryConnectionPoint

inputs

get inputs(): NodeGeometryConnectionPoint[]

Inherited from NodeGeometryBlock.inputs
- Defined in .temp/docdirectory/doc.d.ts:74574
Gets the list of input points

Returns NodeGeometryConnectionPoint[]

isDebug

get isDebug(): boolean

Inherited from NodeGeometryBlock.isDebug
- Defined in .temp/docdirectory/doc.d.ts:74601
Gets a boolean indicating if this block is a debug block

Returns boolean

isInput

get isInput(): boolean

Inherited from NodeGeometryBlock.isInput
- Defined in .temp/docdirectory/doc.d.ts:74589
Gets a boolean indicating if this block is an input

Returns boolean

isTeleportIn

get isTeleportIn(): boolean

Inherited from NodeGeometryBlock.isTeleportIn
- Defined in .temp/docdirectory/doc.d.ts:74597
Gets a boolean indicating if this block is a teleport in

Returns boolean

isTeleportOut

get isTeleportOut(): boolean

Inherited from NodeGeometryBlock.isTeleportOut
- Defined in .temp/docdirectory/doc.d.ts:74593
Gets a boolean indicating if this block is a teleport out

Returns boolean

isUnique

get isUnique(): boolean

Inherited from NodeGeometryBlock.isUnique
- Defined in .temp/docdirectory/doc.d.ts:74605
Gets a boolean indicating that this block can only be used once per NodeGeometry

Returns boolean

name

get name(): string
set name(value: string): void

Inherited from NodeGeometryBlock.name
- Defined in .temp/docdirectory/doc.d.ts:74584
Gets or set the name of the block

Returns string
Inherited from NodeGeometryBlock.name
- Defined in .temp/docdirectory/doc.d.ts:74585
Gets or set the name of the block

Parameters
- value: string
Returns void

outputs

get outputs(): NodeGeometryConnectionPoint[]

Inherited from NodeGeometryBlock.outputs
- Defined in .temp/docdirectory/doc.d.ts:74576
Gets the list of output points

Returns NodeGeometryConnectionPoint[]

radius

get radius(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:73678
Gets the radius input component

Returns NodeGeometryConnectionPoint

radiusX

get radiusX(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:73682
Gets the radiusX input component

Returns NodeGeometryConnectionPoint

radiusY

get radiusY(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:73686
Gets the radiusY input component

Returns NodeGeometryConnectionPoint

radiusZ

get radiusZ(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:73690
Gets the radiusZ input component

Returns NodeGeometryConnectionPoint

subdivisions

get subdivisions(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:73694
Gets the subdivisions input component

Returns NodeGeometryConnectionPoint

Methods

_deserialize Search playground for _deserialize

_deserialize(serializationObject: any): void

Overrides NodeGeometryBlock._deserialize
- Defined in .temp/docdirectory/doc.d.ts:73707
Parameters
- serializationObject: any
Returns void

autoConfigure Search playground for autoConfigure

autoConfigure(): void

Overrides NodeGeometryBlock.autoConfigure
- Defined in .temp/docdirectory/doc.d.ts:73699
Lets the block try to connect some inputs automatically

Returns void

build Search playground for build

build(state: NodeGeometryBuildState): boolean

Inherited from NodeGeometryBlock.build
- Defined in .temp/docdirectory/doc.d.ts:74668
Build the current node and generate the vertex data

Parameters
- state: NodeGeometryBuildState
  
  defines the current generation state
Returns boolean
true if already built

clone Search playground for clone

clone(): null | NodeGeometryBlock

Inherited from NodeGeometryBlock.clone
- Defined in .temp/docdirectory/doc.d.ts:74714
Clone the current block to a new identical block

Returns null | NodeGeometryBlock
a copy of the current block

dispose Search playground for dispose

dispose(): void

Inherited from NodeGeometryBlock.dispose
- Defined in .temp/docdirectory/doc.d.ts:74718
Release resources

Returns void

getClassName Search playground for getClassName

getClassName(): string

Overrides NodeGeometryBlock.getClassName
- Defined in .temp/docdirectory/doc.d.ts:73674
Gets the current class name

Returns string
the class name

getDescendantOfPredicate Search playground for getDescendantOfPredicate

getDescendantOfPredicate(predicate: ((block: NodeGeometryBlock) => boolean)): Nullable<NodeGeometryBlock>

Inherited from NodeGeometryBlock.getDescendantOfPredicate
- Defined in .temp/docdirectory/doc.d.ts:74636
Get the first descendant using a predicate

Parameters
- predicate: ((block: NodeGeometryBlock) => boolean)
  
  defines the predicate to check
  - - (block: NodeGeometryBlock): boolean
    - Parameters
      - block: NodeGeometryBlock
      Returns boolean
Returns Nullable<NodeGeometryBlock>
descendant or null if none found

getInputByName Search playground for getInputByName

getInputByName(name: string): null | NodeGeometryConnectionPoint

Inherited from NodeGeometryBlock.getInputByName
- Defined in .temp/docdirectory/doc.d.ts:74683
Find an input by its name

Parameters
- name: string
  
  defines the name of the input to look for
Returns null | NodeGeometryConnectionPoint
the input or null if not found

getOutputByName Search playground for getOutputByName

getOutputByName(name: string): null | NodeGeometryConnectionPoint

Inherited from NodeGeometryBlock.getOutputByName
- Defined in .temp/docdirectory/doc.d.ts:74689
Find an output by its name

Parameters
- name: string
  
  defines the name of the output to look for
Returns null | NodeGeometryConnectionPoint
the output or null if not found

initialize Search playground for initialize

initialize(): void

Inherited from NodeGeometryBlock.initialize
- Defined in .temp/docdirectory/doc.d.ts:74673
Initialize the block and prepare the context for build

Returns void

isAnAncestorOf Search playground for isAnAncestorOf

isAnAncestorOf(block: NodeGeometryBlock): boolean

Inherited from NodeGeometryBlock.isAnAncestorOf
- Defined in .temp/docdirectory/doc.d.ts:74624
Checks if the current block is an ancestor of a given block

Parameters
- block: NodeGeometryBlock
  
  defines the potential descendant block to check
Returns boolean
true if block is a descendant

isAnAncestorOfType Search playground for isAnAncestorOfType

isAnAncestorOfType(type: string): boolean

Inherited from NodeGeometryBlock.isAnAncestorOfType
- Defined in .temp/docdirectory/doc.d.ts:74630
Checks if the current block is an ancestor of a given type

Parameters
- type: string
  
  defines the potential type to check
Returns boolean
true if block is a descendant

registerInput Search playground for registerInput

registerInput(name: string, type: NodeGeometryBlockConnectionPointTypes, isOptional?: boolean, value?: any, valueMin?: any, valueMax?: any): IcoSphereBlock

Inherited from NodeGeometryBlock.registerInput
- Defined in .temp/docdirectory/doc.d.ts:74652
Register a new input. Must be called inside a block constructor

Parameters
- name: string
  
  defines the connection point name
- type: NodeGeometryBlockConnectionPointTypes
  
  defines the connection point type
- Optional isOptional: boolean
  
  defines a boolean indicating that this input can be omitted
- Optional value: any
  
  value to return if there is no connection
- Optional valueMin: any
  
  min value accepted for value
- Optional valueMax: any
  
  max value accepted for value
Returns IcoSphereBlock
the current block

registerOutput Search playground for registerOutput

registerOutput(name: string, type: NodeGeometryBlockConnectionPointTypes, point?: NodeGeometryConnectionPoint): IcoSphereBlock

Inherited from NodeGeometryBlock.registerOutput
- Defined in .temp/docdirectory/doc.d.ts:74660
Register a new output. Must be called inside a block constructor

Parameters
- name: string
  
  defines the connection point name
- type: NodeGeometryBlockConnectionPointTypes
  
  defines the connection point type
- Optional point: NodeGeometryConnectionPoint
  
  an already created connection point. If not provided, create a new one
Returns IcoSphereBlock
the current block

serialize Search playground for serialize

serialize(): any

Overrides NodeGeometryBlock.serialize
- Defined in .temp/docdirectory/doc.d.ts:73706
Serializes this block in a JSON representation

Returns any
the serialized block object

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

name: string

Returns IcoSphereBlock

Properties

commentsSearch playground for comments

evaluateContextSearch playground for evaluateContext

onBuildObservableSearch playground for onBuildObservable

uniqueIdSearch playground for uniqueId

visibleOnFrameSearch playground for visibleOnFrame

Accessors

buildExecutionTime

Returns number

geometry

Returns NodeGeometryConnectionPoint

inputs

Returns NodeGeometryConnectionPoint[]

isDebug

Returns boolean

isInput

Returns boolean

isTeleportIn

Returns boolean

isTeleportOut

Returns boolean

isUnique

Returns boolean

name

Returns string

Parameters

value: string

Returns void

outputs

Returns NodeGeometryConnectionPoint[]

radius

Returns NodeGeometryConnectionPoint

radiusX

Returns NodeGeometryConnectionPoint

radiusY

Returns NodeGeometryConnectionPoint

radiusZ

Returns NodeGeometryConnectionPoint

subdivisions

Returns NodeGeometryConnectionPoint

Methods

_deserializeSearch playground for _deserialize

Parameters

serializationObject: any

Returns void

autoConfigureSearch playground for autoConfigure

Returns void

buildSearch playground for build

Parameters

state: NodeGeometryBuildState

Returns boolean

cloneSearch playground for clone

Returns null | NodeGeometryBlock

disposeSearch playground for dispose

Returns void

getClassNameSearch playground for getClassName

Returns string

getDescendantOfPredicateSearch playground for getDescendantOfPredicate

Parameters

predicate: ((block: NodeGeometryBlock) => boolean)

Parameters

block: NodeGeometryBlock

Returns boolean

Returns Nullable<NodeGeometryBlock>

getInputByNameSearch playground for getInputByName

Parameters

name: string

Returns null | NodeGeometryConnectionPoint

getOutputByNameSearch playground for getOutputByName

comments Search playground for comments

evaluateContext Search playground for evaluateContext

onBuildObservable Search playground for onBuildObservable

uniqueId Search playground for uniqueId

visibleOnFrame Search playground for visibleOnFrame

_deserialize Search playground for _deserialize

autoConfigure Search playground for autoConfigure

build Search playground for build

clone Search playground for clone

dispose Search playground for dispose

getClassName Search playground for getClassName

getDescendantOfPredicate Search playground for getDescendantOfPredicate

getInputByName Search playground for getInputByName

getOutputByName Search playground for getOutputByName

initialize Search playground for initialize

isAnAncestorOf Search playground for isAnAncestorOf

isAnAncestorOfType Search playground for isAnAncestorOfType

registerInput Search playground for registerInput

registerOutput Search playground for registerOutput

serialize Search playground for serialize