Represents an IrayPlus Attribute
This class is restricted to being called from a program running during an Interactive NX session.
More...
Public Member Functions | |
| NXString | GetValueAsString () |
| Gets an attribute's value as string for specific attribute object The attribute object can be queried from function: NXOpen::Display::IrayPlusMaterialEditorBuilder::GetComponentParameter . More... | |
| NXString | ParameterName () |
| Returns the parameter name of specific material object. More... | |
| void | SetParameterName (const NXString ¶meterName) |
| Sets the parameter name of specific material object. More... | |
| void | SetParameterName (const char *parameterName) |
| Sets the parameter name of specific material object. More... | |
| void | SetValueFromString (const NXString &attribueValue) |
| Sets attribute's value for specific attribute object. More... | |
| void | SetValueFromString (const char *attribueValue) |
| Sets attribute's value for specific attribute object. More... | |
 Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
Detailed Description
Represents an IrayPlus Attribute
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.
IrayPlusMaterialAttribute is not supported in KF.
Created in NX12.0.0.
Member Function Documentation
| NXString NXOpen::Display::IrayPlusMaterialAttribute::GetValueAsString | ( | ) |
Gets an attribute's value as string for specific attribute object The attribute object can be queried from function: NXOpen::Display::IrayPlusMaterialEditorBuilder::GetComponentParameter .
NOTE: The returned attribueValue TEXT should be freed (TEXT_free) by the caller.
- Returns
Created in NX12.0.0.
License requirements : None
| NXString NXOpen::Display::IrayPlusMaterialAttribute::ParameterName | ( | ) |
Returns the parameter name of specific material object.
Created in NX12.0.0.
License requirements : None
| void NXOpen::Display::IrayPlusMaterialAttribute::SetParameterName | ( | const NXString & | parameterName | ) |
Sets the parameter name of specific material object.
Created in NX12.0.0.
License requirements : None
- Parameters
-
parameterName parametername
| void NXOpen::Display::IrayPlusMaterialAttribute::SetParameterName | ( | const char * | parameterName | ) |
Sets the parameter name of specific material object.
Created in NX12.0.0.
License requirements : None
- Parameters
-
parameterName parametername
| void NXOpen::Display::IrayPlusMaterialAttribute::SetValueFromString | ( | const NXString & | attribueValue | ) |
Sets attribute's value for specific attribute object.
Users can follow the steps: (1) Use NXOpen::Display::IrayPlusMaterialEditorBuilder::GetComponentParameter to get all the attribute objects of specific material component. (2)Iterate all these attribute objects. Find the specific attribute you want to modify. For example user want to ReflectionColour-ColourOffset in ClearCoat layer. (3)Pass the attribute object and the new attribute value "1.000000000000000, 0.000000000000000,0.000000000000000" as parameter to call this function.
Created in NX12.0.0.
License requirements : None
- Parameters
-
attribueValue attribuevalue
| void NXOpen::Display::IrayPlusMaterialAttribute::SetValueFromString | ( | const char * | attribueValue | ) |
Sets attribute's value for specific attribute object.
Users can follow the steps: (1) Use NXOpen::Display::IrayPlusMaterialEditorBuilder::GetComponentParameter to get all the attribute objects of specific material component. (2)Iterate all these attribute objects. Find the specific attribute you want to modify. For example user want to ReflectionColour-ColourOffset in ClearCoat layer. (3)Pass the attribute object and the new attribute value "1.000000000000000, 0.000000000000000,0.000000000000000" as parameter to call this function.
Created in NX12.0.0.
License requirements : None
- Parameters
-
attribueValue attribuevalue
The documentation for this class was generated from the following file:
- Display_IrayPlusMaterialAttribute.hxx