FlatPatternProduct.setLightBulbOn Method

Sets the light bulb of many entities all at once. Changing them all at once is more efficient than setting the isLightBulbOn property of each entity one at a time, and the whole change is a single undo step.

Syntax

Python
C++
TypeScript 🧪

"flatPatternProduct_var" is a variable referencing a FlatPatternProduct object.

returnValue = flatPatternProduct_var.setLightBulbOn(entities, isLightBulbOn)

"flatPatternProduct_var" is a variable referencing a FlatPatternProduct object.

#include <Fusion/SheetMetal/FlatPatternProduct.h>

returnValue = flatPatternProduct_var->setLightBulbOn(entities, isLightBulbOn);

"flatPatternProduct_var" is a variable referencing a FlatPatternProduct object.

returnValue = flatPatternProduct_var.setLightBulbOn(entities, isLightBulbOn);

Return Value

boolean

Returns true if setting all of the light bulbs was successful. This is either all or none. If any of the entities does not support a light bulb, the call fails and none of them are changed.

Parameters

entities

Base[]

The entities to change. Any object that supports the isLightBulbOn property can be used, for example Occurrence, BRepBody, and Sketch objects, and the array can contain a mix of those types. The entities must all exist within the Design object you're calling this method from.

isLightBulbOn

boolean

True to turn the light bulbs on and false to turn them off. Entities that are already in the requested state are left unchanged.

FlatPatternProduct.setLightBulbOn Method

Description

Syntax

Return Value

Parameters

Version

Type	Description
boolean	Returns true if setting all of the light bulbs was successful. This is either all or none. If any of the entities does not support a light bulb, the call fails and none of them are changed.

Name	Type	Description
entities	Base[]	The entities to change. Any object that supports the isLightBulbOn property can be used, for example Occurrence, BRepBody, and Sketch objects, and the array can contain a mix of those types. The entities must all exist within the Design object you're calling this method from.
isLightBulbOn	boolean	True to turn the light bulbs on and false to turn them off. Entities that are already in the requested state are left unchanged.