Represents a NXOpen::Display::LightBuilder
This class is restricted to being called from a program running during an Interactive NX session. More...

Inheritance diagram for NXOpen::Display::LightBuilder:

Public Types
enum	LightMode { LightModeFixedToObserver, LightModeFixedToThePart }
	light_mode More...

enum	ShadowType { ShadowTypeNone, ShadowTypeSoftEdged, ShadowTypeHardEdged, ShadowTypeTranslucentHard }
	shadow types More...

Public Member Functions
double	ConeAngle ()
	Returns the cone angle - only applicable to spot light types Created in NX5.0.0. More...

NXOpen::Point *	DestinationPosition ()
	Returns the destination position - only applicable to spot light types Created in NX5.0.0. More...

double	Intensity ()
	Returns the brightness intensity for a given light Created in NX5.0.0. More...

NXOpen::Display::LightBuilder::ShadowType	LightShadowType ()
	Returns the light shadow type - not applicable to ambient or eye light types Created in NX5.0.0. More...

NXOpen::LightType	LightType ()
	Returns the light type for a particular light Created in NX5.0.0. More...

void	SetConeAngle (double coneAngle)
	Sets the cone angle - only applicable to spot light types Created in NX5.0.0. More...

void	SetDestinationPosition (NXOpen::Point *destinationPosition)
	Sets the destination position - only applicable to spot light types Created in NX5.0.0. More...

void	SetIntensity (double intensity)
	Sets the brightness intensity for a given light Created in NX5.0.0. More...

void	SetLightShadowType (NXOpen::Display::LightBuilder::ShadowType lightShadowType)
	Sets the light shadow type - not applicable to ambient or eye light types Created in NX5.0.0. More...

void	SetLightType (NXOpen::LightType lightType)
	Sets the light type for a particular light Created in NX5.0.0. More...

void	SetSourcePosition (NXOpen::Point *sourcePosition)
	Sets the source position - only applicable to spot and point light types Created in NX5.0.0. More...

void	SetUseWithAdvancedStudioImageBasedLighting (bool useWithAdvancedStudioIBl)
	Sets the flag to indicate whether the given light is to be used with image based lighting in the advanced studio display. More...

void	SetUseWithIbl (bool useWithIBL)
	Sets the use_with_ibl flag for a given light More...

void	SetUseWithRayTracedImageBasedLighting (bool useWithRayTracedIBL)
	Sets the flag to indicate whether the given light is to be used with image based lighting in ray traced rendering. More...

NXOpen::Point *	SourcePosition ()
	Returns the source position - only applicable to spot and point light types Created in NX5.0.0. More...

bool	UseWithAdvancedStudioImageBasedLighting ()
	Returns the flag to indicate whether the given light is to be used with image based lighting in the advanced studio display. More...

bool	UseWithIbl ()
	Returns the use_with_ibl flag for a given light More...

bool	UseWithRayTracedImageBasedLighting ()
	Returns the flag to indicate whether the given light is to be used with image based lighting in ray traced rendering. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

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 NULL.

To create a new instance of this class, use NXOpen::ViewCollection::CreateLightBuilder

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::Display::LightBuilder::LightMode

light_mode

Enumerator
LightModeFixedToObserver	fixed to observer
LightModeFixedToThePart	fixed to the part

enum NXOpen::Display::LightBuilder::ShadowType

shadow types

Enumerator
ShadowTypeNone	No shadows will be produced.
ShadowTypeSoftEdged	Soft-edged,approximated shadows will be generated using a shadow mapping algorithm.
ShadowTypeHardEdged	Hard-edged, precise shadows will be generated using a ray-tracing algorithm.
ShadowTypeTranslucentHard	Hard-edged, precise shadows will be generated using a ray-tracing algorithm. Shadows from translucent objects will also be generated and their color will be determined by the transparent object's color.

Member Function Documentation

double NXOpen::Display::LightBuilder::ConeAngle ( )

Returns the cone angle - only applicable to spot light types
Created in NX5.0.0.

License requirements : None

NXOpen::Point* NXOpen::Display::LightBuilder::DestinationPosition ( )

Returns the destination position - only applicable to spot light types
Created in NX5.0.0.

License requirements : None

double NXOpen::Display::LightBuilder::Intensity ( )

Returns the brightness intensity for a given light
Created in NX5.0.0.

License requirements : None

NXOpen::Display::LightBuilder::ShadowType NXOpen::Display::LightBuilder::LightShadowType ( )

Returns the light shadow type - not applicable to ambient or eye light types
Created in NX5.0.0.

License requirements : None

NXOpen::LightType NXOpen::Display::LightBuilder::LightType ( )

Returns the light type for a particular light
Created in NX5.0.0.

License requirements : None

void NXOpen::Display::LightBuilder::SetConeAngle ( double coneAngle )

Sets the cone angle - only applicable to spot light types
Created in NX5.0.0.

License requirements : None

Parameters

coneAngle coneangle

void NXOpen::Display::LightBuilder::SetDestinationPosition ( NXOpen::Point * destinationPosition )

Sets the destination position - only applicable to spot light types
Created in NX5.0.0.

License requirements : None

Parameters

destinationPosition destinationposition

void NXOpen::Display::LightBuilder::SetIntensity ( double intensity )

Sets the brightness intensity for a given light
Created in NX5.0.0.

License requirements : None

Parameters

intensity intensity

void NXOpen::Display::LightBuilder::SetLightShadowType ( NXOpen::Display::LightBuilder::ShadowType lightShadowType )

Sets the light shadow type - not applicable to ambient or eye light types
Created in NX5.0.0.

License requirements : None

Parameters

lightShadowType lightshadowtype

void NXOpen::Display::LightBuilder::SetLightType ( NXOpen::LightType lightType )

Sets the light type for a particular light
Created in NX5.0.0.

License requirements : None

Parameters

lightType lighttype

void NXOpen::Display::LightBuilder::SetSourcePosition ( NXOpen::Point * sourcePosition )

Sets the source position - only applicable to spot and point light types
Created in NX5.0.0.

License requirements : None

Parameters

sourcePosition sourceposition

void NXOpen::Display::LightBuilder::SetUseWithAdvancedStudioImageBasedLighting ( bool useWithAdvancedStudioIBl )

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

Created in NX10.0.0.

License requirements : None

Parameters

useWithAdvancedStudioIBl usewithadvancedstudioibl

void NXOpen::Display::LightBuilder::SetUseWithIbl ( bool useWithIBL )

Sets the use_with_ibl flag for a given light

Deprecated:: Deprecated in NX10.0.0.

This funcationality is no longer supported.

Created in NX5.0.0.

License requirements : None

Parameters

useWithIBL usewithibl

void NXOpen::Display::LightBuilder::SetUseWithRayTracedImageBasedLighting ( bool useWithRayTracedIBL )

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

Created in NX10.0.0.

License requirements : None

Parameters

useWithRayTracedIBL usewithraytracedibl

NXOpen::Point* NXOpen::Display::LightBuilder::SourcePosition ( )

Returns the source position - only applicable to spot and point light types
Created in NX5.0.0.

License requirements : None

bool NXOpen::Display::LightBuilder::UseWithAdvancedStudioImageBasedLighting ( )

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

Created in NX10.0.0.

License requirements : None

bool NXOpen::Display::LightBuilder::UseWithIbl ( )

Returns the use_with_ibl flag for a given light

Deprecated:: Deprecated in NX10.0.0.

This funcationality is no longer supported.

Created in NX5.0.0.

License requirements : None

bool NXOpen::Display::LightBuilder::UseWithRayTracedImageBasedLighting ( )

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

Created in NX10.0.0.

License requirements : None

The documentation for this class was generated from the following file:

Display_LightBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation