CustomGraphicsBasicMaterialColorEffect.specularColor Property

Parent Object: CustomGraphicsBasicMaterialColorEffect
Defined in namespace "adsk::fusion" and the header file is <Fusion/Graphics/CustomGraphicsBasicMaterialColorEffect.h>

Description

Gets and sets the specularColor associated with this CustomGraphicsBasicMaterialColorEffect object. The specular color is the color of reflected light (highlights) as it is reflected off of a shiny surface. For most materials, using white or a light color for the specular color is common practice. This will make the highlights appear bright and noticeable, mimicking how light sources typically reflect off shiny surfaces.

For colored metallic or glossy materials, you might choose a specular color that is tinted based on the material's color. For example, gold might have a yellowish specular color, and copper might have an orange-reddish specular color.

Generally, non-metallic materials (like plastics, ceramics, etc.) have specular colors that are less influenced by the object's base color and more influenced by the light's color. On the other hand, metallic materials tend to have specular highlights that are colored by the material itself.

Syntax

"customGraphicsBasicMaterialColorEffect_var" is a variable referencing a CustomGraphicsBasicMaterialColorEffect object.

# Get the value of the property.
propertyValue = customGraphicsBasicMaterialColorEffect_var.specularColor

# Set the value of the property.
customGraphicsBasicMaterialColorEffect_var.specularColor = propertyValue
"customGraphicsBasicMaterialColorEffect_var" is a variable referencing a CustomGraphicsBasicMaterialColorEffect object.
#include <Fusion/Graphics/CustomGraphicsBasicMaterialColorEffect.h>

// Get the value of the property.
Ptr<Color> propertyValue = customGraphicsBasicMaterialColorEffect_var->specularColor();

// Set the value of the property, where value_var is a Color.
bool returnValue = customGraphicsBasicMaterialColorEffect_var->specularColor(value_var);

Property Value

This is a read/write property whose value is a Color.

Version

Introduced in version September 2017