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

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

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

Public Types

enum  TextureSpace {
  TextureSpaceBox, TextureSpacePlanar, TextureSpaceCylindrical, TextureSpaceSpherical,
  TextureSpaceUVMap
}
 texture spacee type More...
 

Public Member Functions

double AspectRatio ()
 Returns the aspect ratio
Created in NX10.0.2. More...
 
void ExportXMLButton ()
 To export to a XML file
Created in NX10.0.2. More...
 
NXString FileBrowser ()
 Returns the file browser
Created in NX10.0.2. More...
 
std::vector< double > GetColorPicker ()
 Returns the color picker. More...
 
double LatitudeScale ()
 Returns the latitude scale
Created in NX10.0.2. More...
 
double LongitudeScale ()
 Returns the longitude scale
Created in NX10.0.2. More...
 
NXString NameString ()
 Returns the name string
Created in NX10.0.2. More...
 
NXOpen::DirectionNormalVector ()
 Returns the normal vector
Created in NX10.0.2. More...
 
void SaveMaterialsButton ()
 To save to System Studio Materials
Created in NX10.0.2. More...
 
double Scale ()
 Returns the scale
Created in NX10.0.2. More...
 
void SetAspectRatio (double aspectRatio)
 Sets the aspect ratio
Created in NX10.0.2. More...
 
void SetColorPicker (const std::vector< double > &colorPicker)
 Sets the color picker
Created in NX10.0.2. More...
 
void SetFileBrowser (const NXString &filename)
 Sets the file browser
Created in NX10.0.2. More...
 
void SetFileBrowser (const char *filename)
 Sets the file browser
Created in NX10.0.2. More...
 
void SetLatitudeScale (double latitudeScale)
 Sets the latitude scale
Created in NX10.0.2. More...
 
void SetLongitudeScale (double longitudeScale)
 Sets the longitude scale
Created in NX10.0.2. More...
 
void SetNameString (const NXString &nameString)
 Sets the name string
Created in NX10.0.2. More...
 
void SetNameString (const char *nameString)
 Sets the name string
Created in NX10.0.2. More...
 
void SetNormalVector (NXOpen::Direction *normalVector)
 Sets the normal vector
Created in NX10.0.2. More...
 
void SetScale (double scale)
 Sets the scale
Created in NX10.0.2. More...
 
void SetTexturedToggle (bool texturedToggle)
 Sets the textured toggle
Created in NX10.0.2. More...
 
void SetTextureSpaceEnum (NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::TextureSpace textureSpaceEnum)
 Sets the texture space enum
Created in NX10.0.2. More...
 
void SetUpVector (NXOpen::Direction *upVector)
 Sets the up vector
Created in NX10.0.2. More...
 
void SetUScale (double uScale)
 Sets the u scale
Created in NX10.0.2. More...
 
void SetVScale (double vScale)
 Sets the v scale
Created in NX10.0.2. More...
 
bool TexturedToggle ()
 Returns the textured toggle
Created in NX10.0.2. More...
 
NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::TextureSpace TextureSpaceEnum ()
 Returns the texture space enum
Created in NX10.0.2. More...
 
NXOpen::DirectionUpVector ()
 Returns the up vector
Created in NX10.0.2. More...
 
double UScale ()
 Returns the u scale
Created in NX10.0.2. More...
 
double VScale ()
 Returns the v scale
Created in NX10.0.2. 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::IrayPlusSimpleMaterialEditorBuilder
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.



Created in NX10.0.2.

Member Enumeration Documentation

texture spacee type

Enumerator
TextureSpaceBox 

box

TextureSpacePlanar 

planar

TextureSpaceCylindrical 

cylindrical

TextureSpaceSpherical 

spherical

TextureSpaceUVMap 

uvmap

Member Function Documentation

double NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::AspectRatio ( )

Returns the aspect ratio
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

void NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::ExportXMLButton ( )

To export to a XML file
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

NXString NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::FileBrowser ( )

Returns the file browser
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

std::vector<double> NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::GetColorPicker ( )

Returns the color picker.

Returns
Array of 3 RGB values, each between 0 and 1
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")
double NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::LatitudeScale ( )

Returns the latitude scale
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

double NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::LongitudeScale ( )

Returns the longitude scale
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

NXString NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::NameString ( )

Returns the name string
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Direction* NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::NormalVector ( )

Returns the normal vector
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

void NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::SaveMaterialsButton ( )

To save to System Studio Materials
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

double NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::Scale ( )

Returns the scale
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

void NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::SetAspectRatio ( double  aspectRatio)

Sets the aspect ratio
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

Parameters
aspectRatioaspectratio
void NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::SetColorPicker ( const std::vector< double > &  colorPicker)

Sets the color picker
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

Parameters
colorPickerArray of 3 RGB values, each between 0 and 1
void NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::SetFileBrowser ( const NXString filename)

Sets the file browser
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

Parameters
filenamefilename
void NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::SetFileBrowser ( const char *  filename)

Sets the file browser
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

Parameters
filenamefilename
void NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::SetLatitudeScale ( double  latitudeScale)

Sets the latitude scale
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

Parameters
latitudeScalelatitudescale
void NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::SetLongitudeScale ( double  longitudeScale)

Sets the longitude scale
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

Parameters
longitudeScalelongitudescale
void NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::SetNameString ( const NXString nameString)

Sets the name string
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

Parameters
nameStringnamestring
void NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::SetNameString ( const char *  nameString)

Sets the name string
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

Parameters
nameStringnamestring
void NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::SetNormalVector ( NXOpen::Direction normalVector)

Sets the normal vector
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

Parameters
normalVectornormalvector
void NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::SetScale ( double  scale)

Sets the scale
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

Parameters
scalescale
void NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::SetTexturedToggle ( bool  texturedToggle)

Sets the textured toggle
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

Parameters
texturedToggletexturedtoggle
void NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::SetTextureSpaceEnum ( NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::TextureSpace  textureSpaceEnum)

Sets the texture space enum
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

Parameters
textureSpaceEnumtexturespaceenum
void NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::SetUpVector ( NXOpen::Direction upVector)

Sets the up vector
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

Parameters
upVectorupvector
void NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::SetUScale ( double  uScale)

Sets the u scale
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

Parameters
uScaleuscale
void NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::SetVScale ( double  vScale)

Sets the v scale
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

Parameters
vScalevscale
bool NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::TexturedToggle ( )

Returns the textured toggle
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::TextureSpace NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::TextureSpaceEnum ( )

Returns the texture space enum
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Direction* NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::UpVector ( )

Returns the up vector
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

double NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::UScale ( )

Returns the u scale
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")

double NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder::VScale ( )

Returns the v scale
Created in NX10.0.2.



License requirements : studio_render ("UG STUDIO RENDER")


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