User Tools

Site Tools


DzBrickMaterial

Material that uses Shader Bricks to generate its shader.

More...

Inherits :

Static Methods

DAZ Script
DzBrickMaterialconvertDefaultMaterial ( DzDefaultMaterial mat )
DzBrickMaterialconvertUberIrayMaterial ( DzMaterial mat )

Constructors

DAZ Script
DzBrickMaterial ()

Methods

Signals

Detailed Description

TODO: Add detailed description.

Static Methods


DzBrickMaterial : convertDefaultMaterial( DzDefaultMaterial mat )

Converts the given default material to a brick material.

Parameter(s):

  • mat - The material to be converted.

DzBrickMaterial : convertUberIrayMaterial( DzMaterial mat )

Converts the given Uber Iray material to a brick material.

Parameter(s):

  • mat - The material to be converted.

Constructors


DzBrickMaterial()

Creates a new brick material.

Methods


Number : addBrick( shaderbrick_dz brick )

Adds the given brick to this brick material.

Parameter(s):

  • brick - The brick to add.

Return Value:

  • The id of the added brick.

Boolean : allowsAutoBake()

Return Value:

  • true if this brick material allows auto-baking, otherwise false.

void : applyToScene()

Apply a copy of this material to all selected materials in the scene.


void : deleteAllBricks()

Deletes all bricks in this material.


void : deleteBrick( Number id )

Deletes the brick with the given id from the material.

Parameter(s):

  • id - The id of the brick to delete.

void : deleteBrick( shaderbrick_dz brick )

Deletes the given brick from the material.

Parameter(s):

  • brick - The brick to delete.

void : endEditMode()

Takes this brick material out of edit mode.


shaderbrick_dz : getBrick( Number id )

Parameter(s):

  • id - The id of the desired brick.

Return Value:

  • The brick at the given id.

Array : getBrickIDs()

Return Value:

  • A list of the ids for the bricks associated with this brick material.

brickset_dz : getBrickSet( Number i )

Parameter(s):

  • i - The index of the desired brick set.

Return Value:

  • The brick set at the specified location.

String : getBrickUserName()

Return Value:

  • The user name of this brick material.

String : getExtension()

Return Value:

  • The extension for this brick material.

Number : getNumBrickSets()

Return Value:

  • The number of brick sets in this brick material.

void : invalidateSets()

Invalidates the brick sets, causing them to be rebuilt.


Boolean : isInEditMode()

Return Value:

  • true if this brick material is currently in edit mode, otherwise false.

void : setBrickUserName( String name )

Sets the user name of this brick material.

Parameter(s):

  • name - The new name for this brick material.

void : setMaterialName( String name )

Sets the name for this brick material.

Parameter(s):

  • name - The new name to be used.

void : setNeedsPtexParams( Boolean onoff )

Sets whether or not this brick material needs Ptex parameters.

Parameter(s):

  • onoff - If true, this brick material needs Ptex parameters.

void : setNeedsTangentSpaceParams( Boolean onoff )

Sets whether this brick material needs tangent space parameters.

Parameter(s):

  • onoff - If true, this brick material will need tangent space parameters.

void : startEditMode()

Puts this brick material in edit mode.


void : updateIdentifierOnSetInvalidate( Boolean onOff )

Sets whether the identifier is updated when this brick material is invalidated.

Parameter(s):

  • onOff - If true, the identifier will be updated when this brick material is invalidated.

Boolean : usesLocalShaderSpace()

Return Value:

  • true if this brick material uses local shader space.

Signals


void : brickAdded( shaderbrick_dz brick )

Signature:“brickAdded(DzShaderBrick*)”

Emitted when a brick is added to this brick material.

Parameter(s):

  • brick - The brick that was added.

void : brickRemoved( shaderbrick_dz brick )

Signature:“brickRemoved(DzShaderBrick*)”

Emitted when a brick is removed from this brick material.

Parameter(s):

  • brick - The brick that was removed.

void : generateFilesFinished()

Emitted when file generation is finished.


void : generateFilesStarted()

Emitted when file generation is started.