Class GreasedLinePluginMaterial
Hierarchy
- MaterialPluginBase
- GreasedLinePluginMaterial
Implements
Index
Constructors
Properties
Accessors
Methods
- add
Fallbacks - bind
For Sub Mesh - collect
Defines - copy
To - dispose
- fill
Render Target Textures - get
Active Textures - get
Animatables - get
Attributes - get
Class Name - get
Custom Code - get
Samplers - get
Uniform Buffers Names - get
Uniforms - hard
Bind For Sub Mesh - has
Render Target Textures - has
Texture - is
Ready For Sub Mesh - parse
- prepare
Defines - prepare
Defines Before Attributes - serialize
- set
Color - set
Colors - update
Lazy
Constructors
constructor
Creates a new material plugin
Parameters
material: Material
Optional scene: Scene
Optional options: GreasedLineMaterialOptions
Returns GreasedLinePluginMaterial
Properties
color
The mixing mode of the color paramater. Default value is GreasedLineMeshColorMode.SET
colors
The type of sampling of the colors texture. The values are the same when using with textures.
dash
Dash offset
dash
Length of the dash. 0 to 1. 0.5 means half empty, half drawn.
Readonly mark
Helper function to mark defines as being dirty.
Type declaration
Helper function to mark defines as being dirty.
Returns void
nameSearch playground for name
Defines the name of the plugin
prioritySearch playground for priority
Defines the priority of the plugin. Lower numbers run first.
register
Indicates that this plugin should be notified for the extra events (HasRenderTargetTextures / FillRenderTargetTextures / HardBindForSubMesh)
resolve
Indicates that any #include directive in the plugin code must be replaced by the corresponding code.
use
Whether to use the colors option to colorize the line
use
Turns on/off dash mode
visibilitySearch playground for visibility
Normalized value of how much of the line will be visible 0 - 0% of the line will be visible 1 - 100% of the line will be visible
widthSearch playground for width
Line base width. At each point the line width is calculated by widths[pointIndex] * width
Static DEFAULT_
Default line color for newly created lines
Static DEFAULT_
Defaule line width
Static DEFAULT_
Default line width when sizeAttenuation is true
Static Readonly GREASED_
Plugin name
Accessors
color
colors
colors
Gets the color distributiopn type
Returns GreasedLineMeshColorDistributionType
Sets the color distribution type
Parameters
value: GreasedLineMeshColorDistributionType
color distribution type
Returns void
dash
Gets the number of dashes in the line
Returns number
Sets the number of dashes in the line
Parameters
value: number
dash
Returns void
is
Returns boolean
resolution
size
False means 1 unit in width = 1 unit on scene, true means 1 unit in width is reduced on the screen to make better looking lines
Returns boolean
Turn on/off attenuation of the width option and widths array.
Parameters
value: boolean
false means 1 unit in width = 1 unit on scene, true means 1 unit in width is reduced on the screen to make better looking lines
Returns void
Methods
add
Add fallbacks to the effect fallbacks list.
Parameters
defines: MaterialDefines
defines the Base texture to use.
fallbacks: EffectFallbacks
defines the current fallback list.
currentRank: number
defines the current fallback rank.
Returns number
the new fallback rank.
bind
Bind the uniform buffer
Parameters
uniformBuffer: UniformBuffer
Returns void
collect
Collects all defines.
Parameters
defines: {}
The object to append to.
[name: string]: { default: any; type: string }
default: any
type: string
Returns void
copy
Makes a duplicate of the current configuration into another one.
Parameters
plugin: MaterialPluginBase
define the config where to copy the info
Returns void
disposeSearch playground for dispose
Disposes the plugin material.
Returns void
fill
Fills the list of render target textures.
Parameters
renderTargets: SmartArray<RenderTargetTexture>
the list of render targets to update
Returns void
get
Get the shader textures
Parameters
activeTextures: BaseTexture[]
Returns void
get
Returns the animatable textures.
Parameters
animatables: IAnimatable[]
Array of animatable textures.
Returns void
get
Get the shader attributes
Parameters
attributes: string[]
array which will be filled with the attributes
Returns void
get
Get the class name
Returns string
class name
get
Get shader code
Parameters
shaderType: string
vertex/fragment
Returns Nullable<{}>
shader code
get
Get the shader samplers
Parameters
samplers: string[]
Returns void
get
Gets the uniform buffers names added by the plugin.
Parameters
ubos: string[]
list that the ubo names should be added to.
Returns void
get
Get the shader uniforms
Returns { fragment: string; ubo: { name: string; size: number; type: string }[]; vertex: string }
uniforms
fragment: string
ubo: { name: string; size: number; type: string }[]
vertex: string
hard
Binds the material data (this function is called even if mustRebind() returns false)
Parameters
uniformBuffer: UniformBuffer
defines the Uniform buffer to fill in.
scene: Scene
defines the scene the material belongs to.
engine: Engine
defines the engine the material belongs to.
subMesh: SubMesh
the submesh to bind data for
Returns void
has
Gets a boolean indicating that current material needs to register RTT
Returns boolean
true if this uses a render target otherwise false.
has
Checks to see if a texture is used in the material.
Parameters
texture: BaseTexture
Base texture to use.
Returns boolean
- Boolean specifying if a texture is used in the material.
is
Specifies that the submesh is ready to be used.
Parameters
defines: MaterialDefines
the list of "defines" to update.
scene: Scene
defines the scene the material belongs to.
engine: Engine
the engine this scene belongs to.
subMesh: SubMesh
the submesh to check for readiness
Returns boolean
- boolean indicating that the submesh is ready or not.
parseSearch playground for parse
Parses a serialized objects
Parameters
source: any
serialized object
scene: Scene
scene
rootUrl: string
root url for textures
Returns void
prepare
Prepare the defines
Parameters
defines: MaterialGreasedLineDefines
_scene: Scene
_mesh: AbstractMesh
Returns void
prepare
Sets the defines for the next rendering. Called before MaterialHelper.PrepareDefinesForAttributes is called.
Parameters
defines: MaterialDefines
the list of "defines" to update.
scene: Scene
defines the scene to the material belongs to.
mesh: AbstractMesh
the mesh being rendered
Returns void
serializeSearch playground for serialize
Serializes this plugin material
Returns any
serializationObjec
set
set
update
Updates the material. Use when material created in lazy mode.
Returns void
GreasedLinePluginMaterial for GreasedLineMesh