NX Open C++ Reference Guide
|
Represents a Display::LightBuilder
To create a new instance of this class, use ViewCollection::CreateLightBuilder
Created in NX5.0.0.
More...
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::Point * | DestinationPosition () |
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::Point * | SourcePosition () |
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. |
Represents a Display::LightBuilder
To create a new instance of this class, use ViewCollection::CreateLightBuilder
Created in NX5.0.0.
shadow types
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. |
double NXOpen::Display::LightBuilder::ConeAngle | ( | ) |
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
double NXOpen::Display::LightBuilder::Intensity | ( | ) |
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
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
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
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
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
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
sourcePosition | sourceposition |
void NXOpen::Display::LightBuilder::SetUseWithIbl | ( | bool | useWithIBL | ) |
Sets the use_with_ibl flag for a given light
Created in NX5.0.0.
License requirements : None
useWithIBL | usewithibl |
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