Contains property types of Standard material. More...

#include <kanzi/core.ui/graphics3d/standard_material.hpp>

Static Public Member Functions
static ColorRGBA	getAmbientColor (const Object &object)
	Gets the value of the AmbientProperty of an object. More...

static ColorRGBA	getDiffuseColor (const Object &object)
	Gets the value of the DiffuseProperty of an object. More...

static ColorRGBA	getEmissiveColor (const Object &object)
	Gets the value of the EmissiveProperty of an object. More...

static ColorRGBA	getGlobalAmbientColor (const Object &object)
	Gets the value of the GlobalAmbientProperty of an object. More...

static ColorRGBA	getSpecularColor (const Object &object)
	Gets the value of the SpecularColorProperty of an object. More...

static float	getSpecularExponent (const Object &object)
	Gets the value of the SpecularExponentProperty of an object. More...

static ResourceSharedPtr	getTexture (const Object &object)
	Gets the value of the TextureProperty of an object. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

static void	setAmbientColor (Object &object, ColorRGBA value)
	Sets the value of the AmbientProperty of an object. More...

static void	setDiffuseColor (Object &object, ColorRGBA value)
	Sets the value of the DiffuseProperty of an object. More...

static void	setEmissiveColor (Object &object, ColorRGBA value)
	Sets the value of the EmissiveProperty of an object. More...

static void	setGlobalAmbientColor (Object &object, ColorRGBA value)
	Sets the value of GlobalAmbientProperty of an object. More...

static void	setSpecularColor (Object &object, ColorRGBA value)
	Sets the value of the SpecularColorProperty of an object. More...

static void	setSpecularExponent (Object &object, float value)
	Sets the value of the SpecularExponentProperty of an object. More...

static void	setTexture (Object &object, ResourceSharedPtr value)
	Sets the value of the TextureProperty of an object. More...

Static Public Attributes
Properties
static PropertyType< ColorRGBA >	GlobalAmbientProperty
	The color that is multiplied automatically with the AmbientProperty of the materials in the scene. More...

static PropertyType< ColorRGBA >	AmbientProperty
	The color of the material when lights are not present. More...

static PropertyType< ColorRGBA >	DiffuseProperty
	The color of the material when it is lit by a light. More...

static PropertyType< ColorRGBA >	EmissiveProperty
	The color of the light that is emitted from the material surface. More...

static PropertyType< ColorRGBA >	SpecularColorProperty
	The color of the specular reflection. More...

static PropertyType< float >	SpecularExponentProperty
	Determines the size of the specular highlight. More...

static PropertyType< ResourceSharedPtr >	TextureProperty
	The texture of the material. More...

static PropertyType< ResourceSharedPtr >	MaskTextureProperty
	The texture for masking other texture or color. More...

static PropertyType< Vector2 >	TextureTilingProperty
	Determines the number of times a texture is presented in a material. More...

static PropertyType< Vector2 >	TextureOffsetProperty
	The offset for texture in a material. More...

static PropertyType< Vector2 >	MaskTextureTilingProperty
	Determines the number of times a mask is presented in a material. More...

static PropertyType< Vector2 >	MaskTextureOffsetProperty
	Sets an offset for a mask in a material. More...

static PropertyType< float >	BlendIntensityProperty
	Controls the intensity of materials that are blended on top of an existing color. More...

static PropertyType< int >	BlendModeProperty
	Sets the blend mode for a material. More...

static PropertyType< ResourceSharedPtr >	GlyphTextureProperty
	The automatic texture of the glyph cache. More...

Detailed Description

Contains property types of Standard material.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::StandardMaterial::makeEditorInfo ( )

static

◆ getGlobalAmbientColor()

static ColorRGBA kanzi::StandardMaterial::getGlobalAmbientColor ( const Object & object )

inlinestatic

Gets the value of the GlobalAmbientProperty of an object.

Parameters

object The object from which to get the value of the GlobalAmbientProperty.

Returns: Returns the value of the GlobalAmbientProperty.

◆ setGlobalAmbientColor()

static void kanzi::StandardMaterial::setGlobalAmbientColor	(	Object &	object,
		ColorRGBA	value
	)

inlinestatic

Sets the value of GlobalAmbientProperty of an object.

Parameters

object	The object on which to set the GlobalAmbientProperty.
value	The value to which to set the GlobalAmbientProperty.

◆ getAmbientColor()

static ColorRGBA kanzi::StandardMaterial::getAmbientColor ( const Object & object )

inlinestatic

Gets the value of the AmbientProperty of an object.

Parameters

object The object from which to get the value of the AmbientProperty.

Returns: Returns the value of the AmbientProperty.

◆ setAmbientColor()

static void kanzi::StandardMaterial::setAmbientColor	(	Object &	object,
		ColorRGBA	value
	)

inlinestatic

Sets the value of the AmbientProperty of an object.

Parameters

object	The object on which to set the AmbientProperty.
value	The value to which to set the AmbientProperty.

◆ getDiffuseColor()

static ColorRGBA kanzi::StandardMaterial::getDiffuseColor ( const Object & object )

inlinestatic

Gets the value of the DiffuseProperty of an object.

Parameters

object The object from which to get the value of the DiffuseProperty.

Returns: Returns the value of the DiffuseProperty.

◆ setDiffuseColor()

static void kanzi::StandardMaterial::setDiffuseColor	(	Object &	object,
		ColorRGBA	value
	)

inlinestatic

Sets the value of the DiffuseProperty of an object.

Parameters

object	The object on which to set the DiffuseProperty.
value	The value to which to set the DiffuseProperty.

◆ getEmissiveColor()

static ColorRGBA kanzi::StandardMaterial::getEmissiveColor ( const Object & object )

inlinestatic

Gets the value of the EmissiveProperty of an object.

Parameters

object The object from which to get the value of the EmissiveProperty.

Returns: Returns the value of the EmissiveProperty.

◆ setEmissiveColor()

static void kanzi::StandardMaterial::setEmissiveColor	(	Object &	object,
		ColorRGBA	value
	)

inlinestatic

Sets the value of the EmissiveProperty of an object.

Parameters

object	The object on which to set the EmissiveProperty.
value	The value to which to set the EmissiveProperty.

◆ getSpecularColor()

static ColorRGBA kanzi::StandardMaterial::getSpecularColor ( const Object & object )

inlinestatic

Gets the value of the SpecularColorProperty of an object.

Parameters

object The object from which to get the value of the SpecularColorProperty.

Returns: Returns the value of the SpecularColorProperty.

◆ setSpecularColor()

static void kanzi::StandardMaterial::setSpecularColor	(	Object &	object,
		ColorRGBA	value
	)

inlinestatic

Sets the value of the SpecularColorProperty of an object.

Parameters

object	The object on which to set the SpecularColorProperty.
value	The value to which to set the SpecularColorProperty.

◆ getSpecularExponent()

static float kanzi::StandardMaterial::getSpecularExponent ( const Object & object )

inlinestatic

Gets the value of the SpecularExponentProperty of an object.

Parameters

object The object from which to get the value of the SpecularExponentProperty.

Returns: Returns the value of the SpecularExponentProperty.

◆ setSpecularExponent()

static void kanzi::StandardMaterial::setSpecularExponent	(	Object &	object,
		float	value
	)

inlinestatic

Sets the value of the SpecularExponentProperty of an object.

Parameters

object	The object on which to set the SpecularExponentProperty.
value	The value to which to set the SpecularExponentProperty.

◆ getTexture()

static ResourceSharedPtr kanzi::StandardMaterial::getTexture ( const Object & object )

inlinestatic

Gets the value of the TextureProperty of an object.

Parameters

object The object from which to get the value of the TextureProperty.

Returns: Returns the value of the TextureProperty.

◆ setTexture()

static void kanzi::StandardMaterial::setTexture	(	Object &	object,
		ResourceSharedPtr	value
	)

inlinestatic

Sets the value of the TextureProperty of an object.

Parameters

object	The object on which to set the TextureProperty.
value	The value to which to set the TextureProperty.

Member Data Documentation

◆ GlobalAmbientProperty

PropertyType<ColorRGBA> kanzi::StandardMaterial::GlobalAmbientProperty

static

The color that is multiplied automatically with the AmbientProperty of the materials in the scene.

The default value is sRGB ColorRGBA(1.0f, 1.0f, 1.0f, 1.0f).

See also: getGlobalAmbientColor(), getGlobalAmbientColor()

◆ AmbientProperty

PropertyType<ColorRGBA> kanzi::StandardMaterial::AmbientProperty

static

The color of the material when lights are not present.

The default value is sRGB ColorRGBA(0.2f, 0.2f, 0.2f, 1.0f).

See also: setAmbientColor(), getAmbientColor()

◆ DiffuseProperty

PropertyType<ColorRGBA> kanzi::StandardMaterial::DiffuseProperty

static

The color of the material when it is lit by a light.

The default value is sRGB ColorRGBA(0.8f, 0.8f, 0.8f, 1.0f).

See also: setDiffuseColor(), getDiffuseColor()

◆ EmissiveProperty

PropertyType<ColorRGBA> kanzi::StandardMaterial::EmissiveProperty

static

The color of the light that is emitted from the material surface.

The default value is sRGB ColorRGBA(0.0f, 0.0f, 0.0f, 1.0f).

See also: setEmissiveColor(), getEmissiveColor()

◆ SpecularColorProperty

PropertyType<ColorRGBA> kanzi::StandardMaterial::SpecularColorProperty

static

The color of the specular reflection.

The default value is sRGB ColorRGBA(0.4980392f, 0.4980392f, 0.4980392f, 1.0f).

See also: setSpecularColor(), getSpecularColor()

◆ SpecularExponentProperty

PropertyType<float> kanzi::StandardMaterial::SpecularExponentProperty

static

Determines the size of the specular highlight.

The default value is 50.0f.

See also: setSpecularExponent(), getSpecularExponent()

◆ TextureProperty

PropertyType<ResourceSharedPtr> kanzi::StandardMaterial::TextureProperty

static

The texture of the material.

The default value is ResourceSharedPtr().

See also: setTexture(), getTexture()

◆ MaskTextureProperty

PropertyType<ResourceSharedPtr> kanzi::StandardMaterial::MaskTextureProperty

static

The texture for masking other texture or color.

The default value is ResourceSharedPtr().

◆ TextureTilingProperty

PropertyType<Vector2> kanzi::StandardMaterial::TextureTilingProperty

static

Determines the number of times a texture is presented in a material.

The default value is Vector2(1.0f, 1.0f).

◆ TextureOffsetProperty

PropertyType<Vector2> kanzi::StandardMaterial::TextureOffsetProperty

static

The offset for texture in a material.

The default value is Vector2(0.0f, 0.0f).

◆ MaskTextureTilingProperty

PropertyType<Vector2> kanzi::StandardMaterial::MaskTextureTilingProperty

static

Determines the number of times a mask is presented in a material.

The default value is Vector2(1.0f, 1.0f).

◆ MaskTextureOffsetProperty

PropertyType<Vector2> kanzi::StandardMaterial::MaskTextureOffsetProperty

static

Sets an offset for a mask in a material.

The default value is Vector2(0.0f, 0.0f).

◆ BlendIntensityProperty

PropertyType<float> kanzi::StandardMaterial::BlendIntensityProperty

static

Controls the intensity of materials that are blended on top of an existing color.

The default value is 1.0f.

◆ BlendModeProperty

PropertyType<int> kanzi::StandardMaterial::BlendModeProperty

static

Sets the blend mode for a material.

The default value is kanzi::GraphicsBlendModeOpaque.

See also: Renderer::setBlendMode(), Renderer::getBlendMode()

Since: Kanzi 3.9.1 property data type changed from GraphicsBlendMode to int.

◆ GlyphTextureProperty

PropertyType<ResourceSharedPtr> kanzi::StandardMaterial::GlyphTextureProperty

static

The automatic texture of the glyph cache.

The default value is ResourceSharedPtr().

The documentation for this class was generated from the following file:

kanzi/core.ui/graphics3d/standard_material.hpp

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ makeEditorInfo()

◆ getGlobalAmbientColor()

◆ setGlobalAmbientColor()

◆ getAmbientColor()

◆ setAmbientColor()

◆ getDiffuseColor()

◆ setDiffuseColor()

◆ getEmissiveColor()

◆ setEmissiveColor()

◆ getSpecularColor()

◆ setSpecularColor()

◆ getSpecularExponent()

◆ setSpecularExponent()

◆ getTexture()

◆ setTexture()

Member Data Documentation

◆ GlobalAmbientProperty

◆ AmbientProperty

◆ DiffuseProperty

◆ EmissiveProperty

◆ SpecularColorProperty

◆ SpecularExponentProperty

◆ TextureProperty

◆ MaskTextureProperty

◆ TextureTilingProperty

◆ TextureOffsetProperty

◆ MaskTextureTilingProperty

◆ MaskTextureOffsetProperty

◆ BlendIntensityProperty

◆ BlendModeProperty

◆ GlyphTextureProperty