LightBuilder Class

class NXOpen.Display.LightBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Display.LightBuilder

This class is restricted to being called from a program running during an Interactive NX session. If run from a non-interactive session it will return None.

To create a new instance of this class, use NXOpen.ViewCollection.CreateLightBuilder()

New in version NX5.0.0.

Properties

Property Description
ConeAngle Returns or sets the cone angle - only applicable to spot light types
DestinationPosition Returns or sets the destination position - only applicable to spot light types
Intensity Returns or sets the brightness intensity for a given light
LightShadowType Returns or sets the light shadow type - not applicable to ambient or eye light types
LightType Returns or sets the light type for a particular light
SourcePosition Returns or sets the source position - only applicable to spot and point light types
Tag Returns the Tag for this object.
UseWithAdvancedStudioImageBasedLighting Returns or sets the flag to indicate whether the given light is to be used with image based lighting in the advanced studio display.
UseWithIbl Returns or sets the use_with_ibl flag for a given light
UseWithRayTracedImageBasedLighting Returns or sets the flag to indicate whether the given light is to be used with image based lighting in ray traced rendering.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetObject Returns the object currently being edited by this builder.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

ConeAngle

LightBuilder.ConeAngle

Returns or sets the cone angle - only applicable to spot light types

-------------------------------------

Getter Method

Signature ConeAngle

Returns:
Return type:float

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ConeAngle

Parameters:coneAngle (float) –

New in version NX5.0.0.

License requirements: None.

DestinationPosition

LightBuilder.DestinationPosition

Returns or sets the destination position - only applicable to spot light types

-------------------------------------

Getter Method

Signature DestinationPosition

Returns:
Return type:NXOpen.Point

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DestinationPosition

Parameters:destinationPosition (NXOpen.Point) –

New in version NX5.0.0.

License requirements: None.

Intensity

LightBuilder.Intensity

Returns or sets the brightness intensity for a given light

-------------------------------------

Getter Method

Signature Intensity

Returns:
Return type:float

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Intensity

Parameters:intensity (float) –

New in version NX5.0.0.

License requirements: None.

LightShadowType

LightBuilder.LightShadowType

Returns or sets the light shadow type - not applicable to ambient or eye light types

-------------------------------------

Getter Method

Signature LightShadowType

Returns:
Return type:NXOpen.Display.LightBuilderShadowType

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LightShadowType

Parameters:lightShadowType (NXOpen.Display.LightBuilderShadowType) –

New in version NX5.0.0.

License requirements: None.

LightType

LightBuilder.LightType

Returns or sets the light type for a particular light

-------------------------------------

Getter Method

Signature LightType

Returns:
Return type:NXOpen.LightType

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LightType

Parameters:lightType (NXOpen.LightType) –

New in version NX5.0.0.

License requirements: None.

SourcePosition

LightBuilder.SourcePosition

Returns or sets the source position - only applicable to spot and point light types

-------------------------------------

Getter Method

Signature SourcePosition

Returns:
Return type:NXOpen.Point

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SourcePosition

Parameters:sourcePosition (NXOpen.Point) –

New in version NX5.0.0.

License requirements: None.

UseWithAdvancedStudioImageBasedLighting

LightBuilder.UseWithAdvancedStudioImageBasedLighting

Returns or sets the flag to indicate whether the given light is to be used with image based lighting in the advanced studio display.

-------------------------------------

Getter Method

Signature UseWithAdvancedStudioImageBasedLighting

Returns:
Return type:bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature UseWithAdvancedStudioImageBasedLighting

Parameters:useWithAdvancedStudioIBl (bool) –

New in version NX10.0.0.

License requirements: None.

UseWithIbl

LightBuilder.UseWithIbl

Returns or sets the use_with_ibl flag for a given light

-------------------------------------

Getter Method

Signature UseWithIbl

Returns:
Return type:bool

New in version NX5.0.0.

Deprecated since version NX10.0.0: This funcationality is no longer supported.

License requirements: None.

-------------------------------------

Setter Method

Signature UseWithIbl

Parameters:useWithIBL (bool) –

New in version NX5.0.0.

Deprecated since version NX10.0.0: This funcationality is no longer supported.

License requirements: None.

UseWithRayTracedImageBasedLighting

LightBuilder.UseWithRayTracedImageBasedLighting

Returns or sets the flag to indicate whether the given light is to be used with image based lighting in ray traced rendering.

-------------------------------------

Getter Method

Signature UseWithRayTracedImageBasedLighting

Returns:
Return type:bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature UseWithRayTracedImageBasedLighting

Parameters:useWithRayTracedIBL (bool) –

New in version NX10.0.0.

License requirements: None.

Method Detail

Validate

LightBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.