PhotometricLight.shape 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 emitter shape of the light. Down-cast the returned object to the type that matches its shapeType (for example, LineLightShape or CylinderLightShape) to access its dimensions. Use setShape to change the shape type. When a photometric light is created, the default shape is a PointLightShape.

Syntax

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

#include <Fusion/Render/PhotometricLight.h>

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

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

Property Value

Version