NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Display::Reflection Class Reference

Represents a NXOpen::Display::Reflection Reflection defines the source of reflection in shiny objects for Studio rendering style or High Quality Images. More...

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

Public Types

enum  Type { TypeBackground, TypeStage, TypeIbl, TypeImage }
 where the reflections for rendering will be obtained More...
 

Public Member Functions

NXOpen::Display::ImageImage ()
 Returns the reflections's image builder
Created in NX5.0.0. More...
 
NXString ImageFilename ()
 Returns the reflection's image filename
Created in NX5.0.0. More...
 
NXOpen::Display::Reflection::Type ReflectionMap ()
 Returns the reflection type
Created in NX5.0.0. More...
 
void SetImage (NXOpen::Display::Image *imageBuilder)
 Sets the reflections's image builder
Created in NX5.0.0. More...
 
void SetImageFilename (const NXString &imageFileName)
 Sets the reflection's image filename
Created in NX5.0.0. More...
 
void SetImageFilename (const char *imageFileName)
 Sets the reflection's image filename
Created in NX5.0.0. More...
 
void SetReflectionMap (NXOpen::Display::Reflection::Type reflectionMap)
 Sets the reflection type
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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::Reflection Reflection defines the source of reflection in shiny objects for Studio rendering style or High Quality Images.


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

Created in NX5.0.0.

Member Enumeration Documentation

where the reflections for rendering will be obtained

Enumerator
TypeBackground 

use the background for reflections

TypeStage 

use the stage for reflections

TypeIbl 

use the image-based lighting image for reflections

TypeImage 

use the given image file for reflection

Member Function Documentation

NXOpen::Display::Image* NXOpen::Display::Reflection::Image ( )

Returns the reflections's image builder
Created in NX5.0.0.



License requirements : None

NXString NXOpen::Display::Reflection::ImageFilename ( )

Returns the reflection's image filename
Created in NX5.0.0.



License requirements : None

NXOpen::Display::Reflection::Type NXOpen::Display::Reflection::ReflectionMap ( )

Returns the reflection type
Created in NX5.0.0.



License requirements : None

void NXOpen::Display::Reflection::SetImage ( NXOpen::Display::Image imageBuilder)

Sets the reflections's image builder
Created in NX5.0.0.



License requirements : None

Parameters
imageBuilderimage builder
void NXOpen::Display::Reflection::SetImageFilename ( const NXString imageFileName)

Sets the reflection's image filename
Created in NX5.0.0.



License requirements : None

Parameters
imageFileNameimage file name
void NXOpen::Display::Reflection::SetImageFilename ( const char *  imageFileName)

Sets the reflection's image filename
Created in NX5.0.0.



License requirements : None

Parameters
imageFileNameimage file name
void NXOpen::Display::Reflection::SetReflectionMap ( NXOpen::Display::Reflection::Type  reflectionMap)

Sets the reflection type
Created in NX5.0.0.



License requirements : None

Parameters
reflectionMapreflectionmap

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