Class NodeRenderGraphHighlightLayerBlock
Hierarchy (View Summary)
- NodeRenderGraphBlock
- NodeRenderGraphHighlightLayerBlock
Constructors
constructor
-
new NodeRenderGraphHighlightLayerBlock(
name: string,
frameGraph: FrameGraph,
scene: Scene,
layerTextureRatio?: number,
layerTextureFixedSize?: number,
blurTextureSizeRatio?: number,
isStroke?: boolean,
layerTextureType?: any,
): NodeRenderGraphHighlightLayerBlockCreate a new NodeRenderGraphHighlightLayerBlock
Parameters
- name: string
defines the block name
- frameGraph: FrameGraph
defines the hosting frame graph
- scene: Scene
defines the hosting scene
- layerTextureRatio: number = 0.5
multiplication factor applied to the main texture size to compute the size of the layer render target texture (default: 0.5)
OptionallayerTextureFixedSize: numberdefines the fixed size of the layer render target texture. Takes precedence over layerTextureRatio if provided (default: undefined)
- blurTextureSizeRatio: number = 0.5
defines the factor to apply to the layer texture size to create the blur textures (default: 0.5)
- isStroke: boolean = false
should we display highlight as a solid stroke? (default: false)
- layerTextureType: any = Constants.TEXTURETYPE_UNSIGNED_BYTE
defines the type of the layer texture (default: Constants.TEXTURETYPE_UNSIGNED_BYTE)
Returns NodeRenderGraphHighlightLayerBlock
- name: string
Properties
comments
A free comment about the block
on
Gets an observable raised when the block is built
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
blur
-
get blurHorizontalSize(): number
How big is the horizontal kernel of the blur texture
Returns number
-
set blurHorizontalSize(value: number): void
Parameters
- value: number
Returns void
blur
-
get blurTextureSizeRatio(): number
Defines the factor to apply to the layer texture size to create the blur textures
Returns number
-
set blurTextureSizeRatio(value: number): void
Parameters
- value: number
Returns void
blur
-
get blurVerticalSize(): number
How big is the vertical kernel of the blur texture
Returns number
-
set blurVerticalSize(value: number): void
Parameters
- value: number
Returns void
disabled
-
get disabled(): boolean
Gets or sets the disable flag of the task associated with this block
Returns boolean
-
set disabled(value: boolean): void
Parameters
- value: boolean
Returns void
inputs
-
Gets the list of input points
Returns NodeRenderGraphConnectionPoint[]
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 if this block is an input
Returns boolean
is
-
get isStroke(): boolean
Should we display highlight as a solid stroke?
Returns boolean
-
set isStroke(value: boolean): void
Parameters
- value: boolean
Returns void
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
is
-
get isUnique(): boolean
Gets a boolean indicating that this block can only be used once per node render graph
Returns boolean
layer
-
get layer(): NodeRenderGraphConnectionPoint
Gets the layer input component
Returns NodeRenderGraphConnectionPoint
layer
-
get layerTextureFixedSize(): number
Defines the fixed size of the layer render target texture. Takes precedence over layerTextureRatio if provided
Returns number
-
set layerTextureFixedSize(value: number): void
Parameters
- value: number
Returns void
layer
-
get layerTextureRatio(): number
Multiplication factor applied to the main texture size to compute the size of the layer render target texture
Returns number
-
set layerTextureRatio(value: number): void
Parameters
- value: number
Returns void
layer
-
get layerTextureType(): number
Defines the type of the layer texture
Returns number
-
set layerTextureType(value: number): void
Parameters
- value: number
Returns void
name
-
get name(): string
Gets or set the name of the block
Returns string
-
set name(value: string): void
Parameters
- value: string
Returns void
object
-
get objectRenderer(): NodeRenderGraphConnectionPoint
Gets the objectRenderer input component
Returns NodeRenderGraphConnectionPoint
output
-
get output(): NodeRenderGraphConnectionPoint
Gets the output component
Returns NodeRenderGraphConnectionPoint
outputs
-
Gets the list of output points
Returns NodeRenderGraphConnectionPoint[]
target
-
get target(): NodeRenderGraphConnectionPoint
Gets the target texture input component
Returns NodeRenderGraphConnectionPoint
task
-
get task(): FrameGraphHighlightLayerTask
Gets the frame graph task associated with this block
Returns FrameGraphHighlightLayerTask
Methods
auto
-
Lets the block try to connect some inputs automatically
Returns void
build
-
Build the current node and generate the vertex data
Parameters
- state: NodeRenderGraphBuildState
defines the current generation state
Returns boolean
true if already built
- state: NodeRenderGraphBuildState
clone
-
Clone the current block to a new identical block
Returns NodeRenderGraphBlock | null
a copy of the current block
dispose
-
Release resources
Returns void
get
-
Gets the current class name
Returns string
the class name
get
-
getDescendantOfPredicate(
predicate: (block: NodeRenderGraphBlock) => boolean,
): Nullable<NodeRenderGraphBlock>Get the first descendant using a predicate
Parameters
- predicate: (block: NodeRenderGraphBlock) => boolean
defines the predicate to check
Returns Nullable<NodeRenderGraphBlock>
descendant or null if none found
- predicate: (block: NodeRenderGraphBlock) => boolean
get
-
Find an input by its name
Parameters
- name: string
defines the name of the input to look for
Returns NodeRenderGraphConnectionPoint | null
the input or null if not found
- name: string
get
-
Find an output by its name
Parameters
- name: string
defines the name of the output to look for
Returns NodeRenderGraphConnectionPoint | null
the output or null if not found
- name: string
initialize
-
Initialize the block and prepare the context for build
Returns void
is
-
Checks if the current block is an ancestor of a given block
Parameters
- block: NodeRenderGraphBlock
defines the potential descendant block to check
Returns boolean
true if block is a descendant
- block: NodeRenderGraphBlock
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: NodeRenderGraphBlockConnectionPointTypes,
isOptional?: boolean,
point?: NodeRenderGraphConnectionPoint,
): NodeRenderGraphHighlightLayerBlockRegister a new input. Must be called inside a block constructor
Parameters
- name: string
defines the connection point name
- type: NodeRenderGraphBlockConnectionPointTypes
defines the connection point type
- isOptional: boolean = false
defines a boolean indicating that this input can be omitted
Optionalpoint: NodeRenderGraphConnectionPointan already created connection point. If not provided, create a new one
Returns NodeRenderGraphHighlightLayerBlock
the current block
- name: string
register
-
registerOutput(
name: string,
type: NodeRenderGraphBlockConnectionPointTypes,
point?: NodeRenderGraphConnectionPoint,
): NodeRenderGraphHighlightLayerBlockRegister a new output. Must be called inside a block constructor
Parameters
- name: string
defines the connection point name
- type: NodeRenderGraphBlockConnectionPointTypes
defines the connection point type
Optionalpoint: NodeRenderGraphConnectionPointan already created connection point. If not provided, create a new one
Returns NodeRenderGraphHighlightLayerBlock
the current block
- name: string
serialize
-
Serializes this block in a JSON representation
Returns any
the serialized block object
Block that implements the highlight layer