NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Display::LightBuilder Class Reference

Represents a Display::LightBuilder
To create a new instance of this class, use ViewCollection::CreateLightBuilder

Created in NX5.0.0. More...

Inheritance diagram for NXOpen::Display::LightBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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.
NXOpen::PointDestinationPosition ()
 Returns the destination position - only applicable to spot light types
Created in NX5.0.0.
double Intensity ()
 Returns the brightness intensity for a given light
Created in NX5.0.0.
NXOpen::Display::LightBuilder::ShadowType LightShadowType ()
 Returns the light shadow type - not applicable to ambient or eye light types
Created in NX5.0.0.
NXOpen::LightType LightType ()
 Returns the light type for a particular light
Created in NX5.0.0.
void SetConeAngle (double coneAngle)
 Sets the cone angle - only applicable to spot light types
Created in NX5.0.0.
void SetDestinationPosition (NXOpen::Point *destinationPosition)
 Sets the destination position - only applicable to spot light types
Created in NX5.0.0.
void SetIntensity (double intensity)
 Sets the brightness intensity for a given light
Created in NX5.0.0.
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.
void SetLightType (NXOpen::LightType lightType)
 Sets the light type for a particular light
Created in NX5.0.0.
void SetSourcePosition (NXOpen::Point *sourcePosition)
 Sets the source position - only applicable to spot and point light types
Created in NX5.0.0.
void SetUseWithIbl (bool useWithIBL)
 Sets the use_with_ibl flag for a given light
Created in NX5.0.0.
NXOpen::PointSourcePosition ()
 Returns the source position - only applicable to spot and point light types
Created in NX5.0.0.
bool UseWithIbl ()
 Returns the use_with_ibl flag for a given light
Created in NX5.0.0.

Detailed Description

Represents a Display::LightBuilder
To create a new instance of this class, use ViewCollection::CreateLightBuilder

Created in NX5.0.0.



Member Enumeration Documentation

light_mode

Enumerator:
LightModeFixedToObserver 

fixed to observer

LightModeFixedToThePart 

fixed to the part

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

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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:
coneAngleconeangle

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



License requirements : None

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

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



License requirements : None

Parameters:
intensityintensity

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



License requirements : None

Parameters:
lightShadowTypelightshadowtype

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



License requirements : None

Parameters:
lightTypelighttype

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



License requirements : None

Parameters:
sourcePositionsourceposition

Sets the use_with_ibl flag for a given light
Created in NX5.0.0.



License requirements : None

Parameters:
useWithIBLusewithibl

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



License requirements : None

Returns the use_with_ibl flag for a given light
Created in NX5.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.