Class ParticleTextureSourceBlock
Hierarchy (View Summary)
- NodeParticleBlock
- ParticleTextureSourceBlock
Constructors
constructor
-
Create a new ParticleTextureSourceBlock
Parameters
- name: string
defines the block name
Returns ParticleTextureSourceBlock
- name: string
Properties
comments
A free comment about the block
invert
Gets or sets the strenght of the flow map effect
on
Gets an observable raised when the block is built
on
Gets an observable raised when the block is disposed
on
Gets an observable raised when the inputs of the block change
serialized
Indicates if the texture data should be serialized as a base64 string.
unique
Gets or sets the unique id of the node
visible
Gets or sets a boolean indicating that this input can be edited from a collapsed frame
Accessors
inputs
-
Gets the list of input points
Returns NodeParticleConnectionPoint[]
is
-
get isDebug(): boolean
Gets a boolean indicating if this block is a debug block
Returns boolean
is
-
get isInput(): boolean
Gets a boolean indicating that this block is an input block
Returns boolean
is
-
get isSystem(): boolean
Gets a boolean indicating that this block is a system block
Returns boolean
is
-
get isTeleportIn(): boolean
Gets a boolean indicating if this block is a teleport in
Returns boolean
is
-
get isTeleportOut(): boolean
Gets a boolean indicating if this block is a teleport out
Returns boolean
name
-
get name(): string
Gets or set the name of the block
Returns string
-
set name(value: string): void
Parameters
- value: string
Returns void
outputs
-
Gets the list of output points
Returns NodeParticleConnectionPoint[]
source
-
Gets the texture directly set on this block. This value will not be serialized.
Returns Nullable<BaseTexture>
-
Directly sets the texture to be used by this block. This value will not be serialized.
Parameters
- value: Nullable<BaseTexture>
Returns void
texture
-
Gets the texture set on this block. This value will not be serialized.
Returns Nullable<BaseTexture>
-
Sets the texture to be used by this block. This value will not be serialized.
Parameters
- value: Nullable<BaseTexture>
Returns void
texture
-
get textureDataUrl(): string
Gets or sets the data URL of the texture to be used by this block. This is a base64 encoded string representing the texture data.
Returns string
-
set textureDataUrl(value: string): void
Parameters
- value: string
Returns void
texture
-
Gets the texture output component
Returns NodeParticleConnectionPoint
url
-
get url(): string
Gets or sets the URL of the texture to be used by this block.
Returns string
-
set url(value: string): void
Parameters
- value: string
Returns void
Methods
_
-
Builds the block
Parameters
- state: NodeParticleBuildState
defines the current build state
Returns void
- state: NodeParticleBuildState
_
-
Deserializes this block from a serialization object
Parameters
- serializationObject: any
the serialization object
Returns void
- serializationObject: any
build
-
Builds the block
Parameters
- state: NodeParticleBuildState
defines the current build state
Returns boolean
the built block
- state: NodeParticleBuildState
clone
-
Clone the current block to a new identical block
Returns NodeParticleBlock | null
a copy of the current block
dispose
-
Disposes the block and its associated resources
Returns void
extract
-
Gets the texture content as a promise
Returns Promise<any>
a promise that resolves to the texture content, including width, height, and pixel data
get
-
Gets the current class name
Returns string
the class name
get
-
Find an input by its name
Parameters
- name: string
defines the name of the input to look for
Returns NodeParticleConnectionPoint | null
the input or null if not found
- name: string
is
-
Checks if the current block is an ancestor of a given block
Parameters
- block: NodeParticleBlock
defines the potential descendant block to check
Returns boolean
true if block is a descendant
- block: NodeParticleBlock
is
-
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
- type: string
register
-
registerInput(
name: string,
type: NodeParticleBlockConnectionPointTypes,
isOptional?: boolean,
value?: any,
valueMin?: any,
valueMax?: any,
): ParticleTextureSourceBlockRegister a new input. Must be called inside a block constructor
Parameters
- name: string
defines the connection point name
- type: NodeParticleBlockConnectionPointTypes
defines the connection point type
- isOptional: boolean = false
defines a boolean indicating that this input can be omitted
Optionalvalue: anyvalue to return if there is no connection
OptionalvalueMin: anymin value accepted for value
OptionalvalueMax: anymax value accepted for value
Returns ParticleTextureSourceBlock
the current block
- name: string
register
-
registerOutput(
name: string,
type: NodeParticleBlockConnectionPointTypes,
point?: NodeParticleConnectionPoint,
): ParticleTextureSourceBlockRegister a new output. Must be called inside a block constructor
Parameters
- name: string
defines the connection point name
- type: NodeParticleBlockConnectionPointTypes
defines the connection point type
Optionalpoint: NodeParticleConnectionPointan already created connection point. If not provided, create a new one
Returns ParticleTextureSourceBlock
the current block
- name: string
serialize
-
Serializes this block
Returns any
the serialization object
Block used to provide a texture for particles in a particle system