Class GeometryInputBlock

Block used to expose an input value

Hierarchy

NodeGeometryBlock
- GeometryInputBlock

Constructors

constructor

new GeometryInputBlock(name: string, type?: NodeGeometryBlockConnectionPointTypes): GeometryInputBlock

Overrides NodeGeometryBlock.constructor
- Defined in .temp/docdirectory/doc.d.ts:72766
Creates a new InputBlock

Parameters
- name: string
  
  defines the block name
- Optional type: NodeGeometryBlockConnectionPointTypes
  
  defines the type of the input (can be set to NodeGeometryBlockConnectionPointTypes.AutoDetect)
Returns GeometryInputBlock

Properties

comments Search playground for comments

comments: string

A free comment about the block

groupInInspector Search playground for groupInInspector

groupInInspector: string

Gets or sets the group to use to display this block in the Inspector

max Search playground for max

max: number

Gets or set a value used to limit the range of float values

min Search playground for min

min: number

Gets or set a value used to limit the range of float values

onBuildObservable Search playground for onBuildObservable

onBuildObservable: Observable<NodeGeometryBlock>

Gets an observable raised when the block is built

onValueChangedObservable Search playground for onValueChangedObservable

onValueChangedObservable: Observable<GeometryInputBlock>

Gets an observable raised when the value is changed

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:75585
Gets the time spent to build this block (in ms)

Returns number

contextualValue

get contextualValue(): NodeGeometryContextualSources
set contextualValue(value: NodeGeometryContextualSources): void

- Defined in .temp/docdirectory/doc.d.ts:72759
Gets or sets the current contextual value

Returns NodeGeometryContextualSources
- Defined in .temp/docdirectory/doc.d.ts:72760
Gets or sets the current contextual value

Parameters
- value: NodeGeometryContextualSources
Returns void

inputs

get inputs(): NodeGeometryConnectionPoint[]

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

Returns NodeGeometryConnectionPoint[]

isContextual

get isContextual(): boolean

- Defined in .temp/docdirectory/doc.d.ts:72755
Gets a boolean indicating that the current connection point is a contextual value

Returns boolean

isDebug

get isDebug(): boolean

Inherited from NodeGeometryBlock.isDebug
- Defined in .temp/docdirectory/doc.d.ts:75616
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:75604
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:75612
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:75608
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:75620
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:75599
Gets or set the name of the block

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

Parameters
- value: string
Returns void

output

get output(): NodeGeometryConnectionPoint

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

Returns NodeGeometryConnectionPoint

outputs

get outputs(): NodeGeometryConnectionPoint[]

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

Returns NodeGeometryConnectionPoint[]

type

get type(): NodeGeometryBlockConnectionPointTypes

- Defined in .temp/docdirectory/doc.d.ts:72751
Gets or sets the connection point type (default is float)

Returns NodeGeometryBlockConnectionPointTypes

value

get value(): any
set value(value: any): void

- Defined in .temp/docdirectory/doc.d.ts:72771
Gets or sets the value of that point. Please note that this value will be ignored if valueCallback is defined

Returns any
- Defined in .temp/docdirectory/doc.d.ts:72772
Gets or sets the value of that point. Please note that this value will be ignored if valueCallback is defined

Parameters
- value: any
Returns void

valueCallback

get valueCallback(): (() => any)
set valueCallback(value: (() => any)): void

- Defined in .temp/docdirectory/doc.d.ts:72777
Gets or sets a callback used to get the value of that point. Please note that setting this value will force the connection point to ignore the value property

Returns (() => any)
- - (): any
  - Gets or sets a callback used to get the value of that point. Please note that setting this value will force the connection point to ignore the value property
    
    Returns any
- Defined in .temp/docdirectory/doc.d.ts:72778
Gets or sets a callback used to get the value of that point. Please note that setting this value will force the connection point to ignore the value property

Parameters
- value: (() => any)
  - - (): any
    - Returns any
Returns void

Methods

_deserialize Search playground for _deserialize

_deserialize(serializationObject: any): void

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

autoConfigure Search playground for autoConfigure

autoConfigure(): void

Inherited from NodeGeometryBlock.autoConfigure
- Defined in .temp/docdirectory/doc.d.ts:75692
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:75683
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:75729
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

Overrides NodeGeometryBlock.dispose
- Defined in .temp/docdirectory/doc.d.ts:72793
Release resources

Returns void

getClassName Search playground for getClassName

getClassName(): string

Overrides NodeGeometryBlock.getClassName
- Defined in .temp/docdirectory/doc.d.ts:72783
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:75651
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:75698
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:75704
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:75688
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:75639
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:75645
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): GeometryInputBlock

Inherited from NodeGeometryBlock.registerInput
- Defined in .temp/docdirectory/doc.d.ts:75667
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 GeometryInputBlock
the current block

registerOutput Search playground for registerOutput

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

Inherited from NodeGeometryBlock.registerOutput
- Defined in .temp/docdirectory/doc.d.ts:75675
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 GeometryInputBlock
the current block

serialize Search playground for serialize

serialize(): any

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

Returns any

setDefaultValue Search playground for setDefaultValue

setDefaultValue(): void

- Defined in .temp/docdirectory/doc.d.ts:72791
Set the input block to its default value (based on its type)

Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

name: string

Optional type: NodeGeometryBlockConnectionPointTypes

Returns GeometryInputBlock

Properties

commentsSearch playground for comments

groupInInspectorSearch playground for groupInInspector

maxSearch playground for max

minSearch playground for min

onBuildObservableSearch playground for onBuildObservable

onValueChangedObservableSearch playground for onValueChangedObservable

uniqueIdSearch playground for uniqueId

visibleOnFrameSearch playground for visibleOnFrame

Accessors

buildExecutionTime

Returns number

contextualValue

Returns NodeGeometryContextualSources

Parameters

value: NodeGeometryContextualSources

Returns void

inputs

Returns NodeGeometryConnectionPoint[]

isContextual

Returns boolean

isDebug

Returns boolean

isInput

Returns boolean

isTeleportIn

Returns boolean

isTeleportOut

Returns boolean

isUnique

Returns boolean

name

Returns string

Parameters

value: string

Returns void

output

Returns NodeGeometryConnectionPoint

outputs

Returns NodeGeometryConnectionPoint[]

type

Returns NodeGeometryBlockConnectionPointTypes

value

Returns any

Parameters

value: any

Returns void

valueCallback

Returns (() => any)

Returns any

Parameters

value: (() => any)

Returns any

Returns void

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

comments Search playground for comments

groupInInspector Search playground for groupInInspector

max Search playground for max

min Search playground for min

onBuildObservable Search playground for onBuildObservable

onValueChangedObservable Search playground for onValueChangedObservable

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

setDefaultValue Search playground for setDefaultValue