NXOpen::Display::Reflection Class Reference

Represents a 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:

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

Public Member Functions
NXOpen::Display::Image *	Image ()
	Returns the reflections's image builder Created in NX5.0.0.
NXString	ImageFilename ()
	Returns the reflection's image filename Created in NX5.0.0.
NXOpen::Display::Reflection::Type	ReflectionMap ()
	Returns the reflection type Created in NX5.0.0.
void	SetImage (NXOpen::Display::Image *imageBuilder)
	Sets the reflections's image builder Created in NX5.0.0.
void	SetImageFilename (const NXString &imageFileName)
	Sets the reflection's image filename Created in NX5.0.0.
void	SetImageFilename (const char *imageFileName)
	Sets the reflection's image filename Created in NX5.0.0.
void	SetReflectionMap (NXOpen::Display::Reflection::Type reflectionMap)
	Sets the reflection type Created in NX5.0.0.
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

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

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

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::Display::Reflection::Type

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

imageBuilder

image builder

void NXOpen::Display::Reflection::SetImageFilename

(

const NXString &

imageFileName

)

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

License requirements : None

Parameters

imageFileName

image 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

imageFileName

image 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

reflectionMap

reflectionmap

---

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

• Display_Reflection.hxx