vrdWovenClothMaterial

class vrdWovenClothMaterial

(Inherits vrdBRDFMaterial)

This class is used to handle all woven cloth material properties.

class ClothPreset
Custom
CottonJersey
CottonTwill31
Jeans
LinenFine
LinenCoarse
Nylon
Satin
Silk
TableClothCotton
Viscose
class WeaveType
PlainPattern
Twill31Pattern
Twill51Pattern
DenimPattern
SatinPattern
SilkPattern
class YarnType
StapleYarn

Staple Yarn simulates yarn that is made up of many tiny threads. Use this type for rough types of clothes such as denim.

FilamentYarn

Filament Yarn simulates yarn that is made up of one single untwisted yarn. Use this type for shiny types of clothes such as silk.

Functions

vrdWovenClothMaterial.getBumpTexture()

Gets access to all properties of vrdBumpTexture.

Returns:An vrdBumpTexture object, to read and write access of alls properties.
Return type:vrdBumpTexture
vrdWovenClothMaterial.getDarkening()

Gets the appearance of the diffuse component.

Returns:Current value of the appearance of the diffuse component.
Return type:float
vrdWovenClothMaterial.getDiffuseColor()
Returns:The current diffuse color value
Return type:QVector3D
vrdWovenClothMaterial.getDiffuseColorSpectrum()

Gets the diffuse color spectrum.

Returns:The current used spectrum for diffuse color
Return type:vrSpectrum
vrdWovenClothMaterial.getDiffuseTexture()

Gets access to all properties of the diffuse texture.

Returns:An vrdTexture object, to read and write access of alls properties.
Return type:vrdTexture
vrdWovenClothMaterial.getDisplacementTexture()

Gets access to all properties of vrdDisplacementTexture.

Returns:An vrdDisplacementTexture object, to read and write access of alls properties.
Return type:vrdDisplacementTexture
vrdWovenClothMaterial.getExposure()

Get the current value for exposure.

Returns:The current value for exposure.
Return type:float
vrdWovenClothMaterial.getHighlightWidth()

Gets the width of the glossy highlight on the yarn segments.

Returns:Current value of the width of the glossy highlight on the yarn segments.
Return type:float
vrdWovenClothMaterial.getIncandescence()

Gets access to all properties of vrdIncandescence.

Returns:An vrdIncandescence object, to read and write access of alls properties.
Return type:vrdIncandescence
vrdWovenClothMaterial.getMoireRemoval()

Gets how softens that moire pattern is.

Returns:The current used value for softness.
Return type:float
vrdWovenClothMaterial.getNoiseIntensity()

Gets a natural noise effect for matte surfaces (staple yarn is recommended).

Returns:The current used value for the natural noise effect.
Return type:float
vrdWovenClothMaterial.getPresetChoice()
Returns:Current cloth preset. Will be vrdWovenClothMaterial::ClothPreset::Custom if custom settings have been set in this material.
Return type:vrdWovenClothMaterial.ClothPreset
vrdWovenClothMaterial.getSubsurfaceScattering()

Gets access to all properties of vrdSubsurfaceScattering.

Returns:An vrdSubsurfaceScattering object, to read and write access of alls properties.
Return type:vrdSubsurfaceScattering
vrdWovenClothMaterial.getTextureSettings()

Gets access to all properties of vrdTextureSettings.

For vrdWovenClothMaterial, the texture mapping type of vrdTextureSettings can be set to either vrTextureTypes.MappingType.UVMapping or vrTextureTypes.MappingType.TriplanarMapping. It influences both how the procedural weaving pattern is mapped on the surface, and the texture mapping of diffuse, glossy, bump and subsurface scattering textures.

For triplanar mapping, the triplanar settings from the vrdTextureSettings object are used. For UV mapping, the UV repeat and rotate settings from the vrdTextureSettings object are used. Repeat mode is to be set in the individual vrdTexture objects.

Please note, the repeat, offset and rotate settings in the individual vrdTexture objects are applied in addition to the global texture settings.

Returns:An vrdTextureSettings object, to read and write access of alls properties.
Return type:vrdTextureSettings
vrdWovenClothMaterial.getWarpYarnColor()

Gets the color of the vertical (warp) yarn.

Returns:Current color of the vertical (warp) yarn.
Return type:QVector3D
vrdWovenClothMaterial.getWarpYarnColorSpectrum()

Gets the color spectrum of the vertical (warp) yarn.

Returns:The current used spectrum for the vertical (warp) yarn.
Return type:vrSpectrum
vrdWovenClothMaterial.getWarpYarnCurvature()

Gets the curvature of the vertical (warp) yarn.

Returns:Current curvature of the vertical (warp) yarn.
Return type:float
vrdWovenClothMaterial.getWeaveType()

Gets how the yarn is woven to cloth.

Returns:The current weave type.
Return type:vrdWovenClothMaterial.WeaveType
vrdWovenClothMaterial.getWeftYarnColor()

Gets the color of the horizontal (weft) yarn.

Returns:Current color of the horizontal (weft) yarn.
Return type:QVector3D
vrdWovenClothMaterial.getWeftYarnColorSpectrum()

Gets the color spectrum of the horizontal (weft) yarn.

Returns:The current used spectrum for the horizontal (weft) yarn.
Return type:vrSpectrum
vrdWovenClothMaterial.getWeftYarnCurvature()

Gets the curvature of the horizontal (weft) yarn.

Returns:The current used curvature of the horizontal (weft) yarn.
Return type:float
vrdWovenClothMaterial.getYarnTexture()

Gets access to all properties of the yarn texture.

Returns:An vrdTexture object, to read and write access of alls properties.
Return type:vrdTexture
vrdWovenClothMaterial.getYarnTwistAngle()

Gets the glossiness of the yarn and depends on the choice made in the yarn type.

Returns:The current value of the glossiness of the yarn.
Return type:float
vrdWovenClothMaterial.getYarnType()

Gets the glossiness of the yarn.

Returns:The current value of the glossiness of the yarn.
Return type:vrdWovenClothMaterial.YarnType
vrdWovenClothMaterial.setDarkening(v)

Controls the appearance of the diffuse component. The default darkening value of 1.0 corresponds with a perfectly diffuse surface. Higher values than 1.0 darken the material, lower values brighten it up.

Parameters:v (float) – New value of the appearance of the diffuse component.
vrdWovenClothMaterial.setDiffuseColor(value)

Sets the diffuse reflection color of the material. Diffuse reflections can be further controlled with the darkening value.

Parameters:value (QVector3D) –
vrdWovenClothMaterial.setDiffuseColorSpectrum(value)

Sets the diffuse color spectrum.

Parameters:value (vrSpectrum) – New spectrum for diffuse color
vrdWovenClothMaterial.setExposure(exposure)

Defines the brightness of the glossy component.

Parameters:exposure (float) – The new used value for exposure.
vrdWovenClothMaterial.setHighlightWidth(v)

Defines the width of the glossy highlight on the yarn segments.

Parameters:v (float) – New value of the width of the glossy highlight on the yarn segments.
vrdWovenClothMaterial.setMoireRemoval(v)

Softens that moire pattern. The higher the value, the more effective the moire pattern is softened. If too high, any structure is softened and surface information might get lost.

Parameters:v (float) – The new used value for softness.
vrdWovenClothMaterial.setNoiseIntensity(v)

Sets a natural noise effect for matte surfaces (staple yarn is recommended).

Parameters:v (float) – The new used value for the natural noise effect.
vrdWovenClothMaterial.setPresetChoice(v)

Sets a handpicked material preset, which is also available in the VRED Example Assets in the Asset Manager. The parameters change automatically when a cloth preset is selected.

Parameters:v (vrdWovenClothMaterial.ClothPreset) – New index of a handpicked material preset.
vrdWovenClothMaterial.setWarpYarnColor(value)

Sets the color of the vertical (warp) yarn. It is best practice to use similar colors for warp and weft yarn.

Parameters:value (QVector3D) – New color of the vertical (warp) yarn.
vrdWovenClothMaterial.setWarpYarnColorSpectrum(value)

Sets the color spectrum of the vertical (warp) yarn.

Parameters:value (vrSpectrum) – New spectrum for the vertical (warp) yarn.
vrdWovenClothMaterial.setWarpYarnCurvature(v)

Defines the curvature of the vertical (warp) yarn.

Parameters:v (float) – New curvature of the vertical (warp) yarn.
vrdWovenClothMaterial.setWeaveType(v)

Defines how the yarn is woven to cloth.

Parameters:v (vrdWovenClothMaterial.WeaveType) – The new weave type.
vrdWovenClothMaterial.setWeftYarnColor(value)

Sets the color of the horizontal (weft) yarn. It is best practice to use similar colors for warp and weft yarn.

Parameters:value (QVector3D) – New color of the horizontal (weft) yarn.
vrdWovenClothMaterial.setWeftYarnColorSpectrum(value)

Sets the color spectrum of the horizontal (weft) yarn.

Parameters:value (vrSpectrum) – New spectrum for the horizontal (weft) yarn.
vrdWovenClothMaterial.setWeftYarnCurvature(v)

Defines the curvature of the horizontal (weft) yarn.

Parameters:v (float) – The new curvature of the horizontal (weft) yarn.
vrdWovenClothMaterial.setYarnTwistAngle(v)

Determines the glossiness of the yarn and depends on the choice made in the yarn type.

Parameters:v (float) – The new value of the glossiness of the yarn.
vrdWovenClothMaterial.setYarnType(v)

Defines the glossiness of the yarn.

Parameters:v (vrdWovenClothMaterial.YarnType) – The new value of the glossiness of the yarn.