public interface IrayPlusMaterialEditorBuilder extends Builder
IrayPlusMaterialEditorBuilder
Modifier and Type | Interface and Description |
---|---|
static class |
IrayPlusMaterialEditorBuilder.AddComponentData
This class holds the data returned from
addComponent(java.lang.String) |
static class |
IrayPlusMaterialEditorBuilder.ComponentInfoData
This class holds the data returned from
getComponentInfo(java.lang.String) |
static class |
IrayPlusMaterialEditorBuilder.LayerType
Layer types used in iray plus material
|
static class |
IrayPlusMaterialEditorBuilder.MaterialLayersInfoData
This class holds the data returned from
getMaterialLayersInfo() |
Modifier and Type | Method and Description |
---|---|
IrayPlusMaterialEditorBuilder.AddComponentData |
addComponent(String componentType)
Adds a component to layers for specific layer type.
|
void |
exportToXMLFile(String exportXmlFileName)
Exports current material of material editor builder into a XML file.
|
IrayPlusMaterialEditorBuilder.ComponentInfoData |
getComponentInfo(String componentName)
Get all the attribute name of a component.
|
IrayPlusMaterialAttribute |
getComponentParameter(String attribueName)
Gets single attribute object for specific fomatted attribute name
The string attribute name format should be :
"layer name-interface name-attribute name"
Let material ''Varnished Cherry' for example:
If user wants to get 'Base' component's attribueObject of 'Base-Colour-Colour'.
|
String |
getComponentParameterValue(String attribueName)
Gets attribute's value as string for specific fomatted attribute name
The string attribute name format should be :
"layer name-interface name-attribute name"
Let material ''Varnished Cherry' for example:
If user wants to get 'Base' component's value of 'Base-Colour-Colour'.
|
String |
getImageParameterFullPath(String imageAttribueName)
To return the absolute path of specific image type parameter.
|
IrayPlusMaterialEditorBuilder.MaterialLayersInfoData |
getMaterialLayersInfo()
Get all the components unique name and type name of this material.
|
String |
materialName()
Returns the current material name of material editor builder.
|
void |
moveComponent(int index,
String componentType,
boolean moveUp)
Moves a component of layers up and down of layers stack.
|
boolean |
previewToggle()
Returns a boolean value that indicate whether the preview toggle is ON.
|
void |
removeComponent(int index,
String componentType)
Removes a component to layers for specific layer index
Let material ''Varnished Cherry' for example:
If use changed the material has two Layers: Dir1 and ClearCoat.
|
void |
saveToSystemStudioMaterials(String saveXmlFileName)
Saves the material to System Studio Materials which is a directory under
ugphoto/IrayPlus_ug_canned_mattex.
|
String[] |
setComponentParameter(String attribueName,
IrayPlusMaterialAttribute attribueObject)
Sets attribute object for specific fomatted attribute name
The string attribute name format should be :
"layer name-interface name-attribute name"
Let material ''Varnished Cherry' for example:
If user wants to set 'Base' component's attribueObject of 'Base-Colour-Colour'.
|
String[] |
setComponentParameterValue(String attribueName,
String attribueValue)
Sets attribute value for specific fomatted attribute name
The string attribute name format should be :
"layer name-interface name-attribute name"
Let material ''Varnished Cherry' for example:
If user wants to set 'Base' component's value of 'Base-Colour-Colour'.
|
void |
setMaterialName(String materialName)
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
setPreviewToggle(boolean toggleOn)
License requirements: studio_render ("UG STUDIO RENDER") . |
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
IrayPlusMaterialEditorBuilder.MaterialLayersInfoData getMaterialLayersInfo() throws NXException, RemoteException
NXException
RemoteException
IrayPlusMaterialEditorBuilder.ComponentInfoData getComponentInfo(String componentName) throws NXException, RemoteException
componentName
- NXException
RemoteException
IrayPlusMaterialEditorBuilder.AddComponentData addComponent(String componentType) throws NXException, RemoteException
componentType
- NXException
RemoteException
void removeComponent(int index, String componentType) throws NXException, RemoteException
index
- componentType
- NXException
RemoteException
void moveComponent(int index, String componentType, boolean moveUp) throws NXException, RemoteException
index
- componentType
- moveUp
- NXException
RemoteException
IrayPlusMaterialAttribute getComponentParameter(String attribueName) throws NXException, RemoteException
attribueName
- NXException
RemoteException
String getComponentParameterValue(String attribueName) throws NXException, RemoteException
attribueName
- NXException
RemoteException
String[] setComponentParameter(String attribueName, IrayPlusMaterialAttribute attribueObject) throws NXException, RemoteException
attribueName
- attribueObject
- NXException
RemoteException
String[] setComponentParameterValue(String attribueName, String attribueValue) throws NXException, RemoteException
attribueName
- attribueValue
- NXException
RemoteException
String materialName() throws NXException, RemoteException
NXException
RemoteException
void setMaterialName(String materialName) throws NXException, RemoteException
materialName
- NXException
RemoteException
boolean previewToggle() throws NXException, RemoteException
NXException
RemoteException
void setPreviewToggle(boolean toggleOn) throws NXException, RemoteException
toggleOn
- NXException
RemoteException
void saveToSystemStudioMaterials(String saveXmlFileName) throws NXException, RemoteException
saveXmlFileName
- NXException
RemoteException
void exportToXMLFile(String exportXmlFileName) throws NXException, RemoteException
exportXmlFileName
- NXException
RemoteException
String getImageParameterFullPath(String imageAttribueName) throws NXException, RemoteException
imageAttribueName
- NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.