PhotometricLight.distribution Property

This functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.

Description

Returns the object that defines the luminous distribution of the light. Down-cast the returned object to the type that matches its distributionType (for example, SpotLightDistribution or WebLightDistribution) to access type-specific properties. Use setDistribution to change the distribution type. When a photometric light is created, the default distribution is a UniformLightDistribution.

Syntax

# Get the value of the property.
propertyValue = photometricLight_var.distribution

#include <Fusion/Render/PhotometricLight.h>

// Get the value of the property.
Ptr<LightDistribution> propertyValue = photometricLight_var->distribution();

// Get the value of the property.
propertyValue = photometricLight_var.distribution;

Property Value

Version