Interface ICoatings

Gives access to methods to read or write in a coating document.

Namespace: TopSolid.Cad.Design.Automating

Assembly: TopSolid.Cad.Design.Automating.dll

Syntax

[ServiceContract]
[AvailableSinceVersion(7, 16, 0, 0)]
public interface ICoatings

Remarks

This interface is available since v7.16.

Methods

CreateCoatingParameter(DocumentId, PdmMinorRevisionId)

Creates a coating parameter into a document

Declaration

[OperationContract]
[AvailableSinceVersion(7, 19, 400, 160)]
ElementId CreateCoatingParameter(DocumentId inDocumentId, PdmMinorRevisionId inPdmMinorRevisionId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Id of the container document
PdmMinorRevisionId	inPdmMinorRevisionId	Minor revision of the coating document to reference

Returns

Type	Description
ElementId	Id of the created parameter.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.19.400.160

GetAlbedoColor(DocumentId)

Gets the Albado color.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
Color GetAlbedoColor(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
Color

Remarks

This method is available since v7.16.

GetAlbedoTextureDocument(DocumentId)

Gets the Albado texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
DocumentId GetAlbedoTextureDocument(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
DocumentId

Remarks

This method is available since v7.16.

GetAmbientOcclusionFactor(DocumentId)

Gets the Ambient Occlusion factor.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
double GetAmbientOcclusionFactor(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
Double

Remarks

This method is available since v7.16.

GetAmbientOcclusionTextureDocument(DocumentId)

Gets the Ambient Occlusion texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
DocumentId GetAmbientOcclusionTextureDocument(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
DocumentId

Remarks

This method is available since v7.16.

GetAnisotropyAngleFactor(DocumentId)

Gets the Anisotropy factor.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 18, 0, 0)]
double GetAnisotropyAngleFactor(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
Double

Remarks

This method is available since v7.18.

GetAnisotropyAngleTextureDocument(DocumentId)

Gets the Anisotropy texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 18, 0, 0)]
DocumentId GetAnisotropyAngleTextureDocument(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
DocumentId

Remarks

This method is available since v7.18.

GetCategory(DocumentId)

Gets the coating category of a coating document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
CoatingCategoryType GetCategory(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
CoatingCategoryType	The coating category.

Remarks

This method is available since v7.16.

GetCoatingApperanceInfo(DocumentId, out Boolean, out Boolean, out Boolean, out Boolean)

Gets the coating apperance information.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
void GetCoatingApperanceInfo(DocumentId inDocumentId, out bool outReceiveShadows, out bool outCastShadows, out bool outFresnelReflection, out bool outTransparentReflection)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.
Boolean	outReceiveShadows	Tells wether the coating receive shadows.
Boolean	outCastShadows	Tells wether the coating cast shadows.
Boolean	outFresnelReflection	Tells wether the coating has a frenesl reflection.
Boolean	outTransparentReflection	Tells wether the coating has transparent reflection.

Remarks

This method is available since v7.16.

GetCoatingParameterValue(ElementId, out DocumentId, out CoatingCategoryType)

Gets Document and Category from a Coating Parameter

Declaration

[OperationContract]
[AvailableSinceVersion(7, 19, 400, 160)]
void GetCoatingParameterValue(ElementId inParameterId, out DocumentId outDocumentId, out CoatingCategoryType outCoatingType)

Parameters

Type	Name	Description
ElementId	inParameterId	The Id of the parameter
DocumentId	outDocumentId	Coating Document
CoatingCategoryType	outCoatingType	Coating category type of the document

GetDensity(DocumentId)

Gets the coating density.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
double GetDensity(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
Double

Remarks

This method is available since v7.16.

GetGlossinessFactor(DocumentId)

Gets the Glossiness factor.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 18, 0, 0)]
double GetGlossinessFactor(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
Double

Remarks

This method is available since v7.18.

GetGlossinessTextureDocument(DocumentId)

Gets the Glossiness texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 18, 0, 0)]
DocumentId GetGlossinessTextureDocument(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
DocumentId

Remarks

This method is available since v7.18.

GetMetalnessFactor(DocumentId)

Gets the Metalness factor.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
double GetMetalnessFactor(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
Double

Remarks

This method is available since v7.16.

GetMetalnessTextureDocument(DocumentId)

Gets the Metalness texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
DocumentId GetMetalnessTextureDocument(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
DocumentId

Remarks

This method is available since v7.16.

GetNormalFactor(DocumentId)

Gets the Normal factor.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
double GetNormalFactor(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
Double

Remarks

This method is available since v7.16.

GetNormalTextureDocument(DocumentId)

Gets the Normal texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
DocumentId GetNormalTextureDocument(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
DocumentId

Remarks

This method is available since v7.16.

GetOpacityColor(DocumentId)

Gets the Opacity color.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
Color GetOpacityColor(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
Color

Remarks

This method is available since v7.16.

GetOpacityTextureDocument(DocumentId)

Gets the Opacity texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
DocumentId GetOpacityTextureDocument(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
DocumentId

Remarks

This method is available since v7.16.

GetRefractiveIndex(DocumentId)

Gets the refractive index.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
double GetRefractiveIndex(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
Double

Remarks

This method is available since v7.16.

GetRotation(DocumentId)

Gets the rotation.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
double GetRotation(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
Double

Remarks

This method is available since v7.16.

GetRoughnessFactor(DocumentId)

Gets the Roughness factor.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
double GetRoughnessFactor(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
Double

Remarks

This method is available since v7.16.

GetRoughnessTextureDocument(DocumentId)

Gets the Roughness texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
DocumentId GetRoughnessTextureDocument(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
DocumentId

Remarks

This method is available since v7.16.

GetScale(DocumentId)

Gets the scale.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
double GetScale(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
Double

Remarks

This method is available since v7.16.

GetSpecularColor(DocumentId)

Gets the Specular color.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 18, 0, 0)]
Color GetSpecularColor(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
Color

Remarks

This method is available since v7.18.

GetSpecularTextureDocument(DocumentId)

Gets the Specular texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 18, 0, 0)]
DocumentId GetSpecularTextureDocument(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
DocumentId

Remarks

This method is available since v7.18.

GetTransmissionGlossinessFactor(DocumentId)

Gets the Transmission Glossiness factor.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
double GetTransmissionGlossinessFactor(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
Double

Remarks

This method is available since v7.16.

GetTransmissionGlossinessTextureDocument(DocumentId)

Gets the Transmission Glossiness texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
DocumentId GetTransmissionGlossinessTextureDocument(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
DocumentId

Remarks

This method is available since v7.16.

GetTransmissionScatteringColor(DocumentId)

Gets the Transmission Scattering color.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
Color GetTransmissionScatteringColor(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
Color

Remarks

This method is available since v7.16.

GetTransmissionScatteringLength(DocumentId)

Gets the Transmission Scattering length.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
double GetTransmissionScatteringLength(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
Double

Remarks

This method is available since v7.16.

IsCoatingParameter(ElementId)

Tells if an element is a Coating Parameter

Declaration

[OperationContract]
[AvailableSinceVersion(7, 19, 400, 160)]
bool IsCoatingParameter(ElementId inParameterId)

Parameters

Type	Name	Description
ElementId	inParameterId	The Id of the parameter

Returns

Type	Description
Boolean	true if it is a coating parameter

SetAlbedoColor(DocumentId, Color)

Sets the Albado color.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetAlbedoColor(DocumentId inDocumentId, Color inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Color	inValue	Wanted value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetAlbedoTextureDocument(DocumentId, DocumentId)

Sets the Albado texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetAlbedoTextureDocument(DocumentId inDocumentId, DocumentId inTextureDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
DocumentId	inTextureDocumentId	Texture document.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetAmbientOcclusionFactor(DocumentId, Double)

Sets the Ambient Occlusion factor.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetAmbientOcclusionFactor(DocumentId inDocumentId, double inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Double	inValue	Wanted value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetAmbientOcclusionTextureDocument(DocumentId, DocumentId)

Sets the Ambient Occlusion texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetAmbientOcclusionTextureDocument(DocumentId inDocumentId, DocumentId inTextureDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
DocumentId	inTextureDocumentId	Texture document.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetAnisotropyAngleFactor(DocumentId, Double)

Sets the Anisotropy factor.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 18, 0, 0)]
void SetAnisotropyAngleFactor(DocumentId inDocumentId, double inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Double	inValue	Wanted value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.

SetAnisotropyAngleTextureDocument(DocumentId, DocumentId)

Sets the Anisotropy texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 18, 0, 0)]
void SetAnisotropyAngleTextureDocument(DocumentId inDocumentId, DocumentId inTextureDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
DocumentId	inTextureDocumentId	Texture document.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.

SetCategory(DocumentId, CoatingCategoryType)

Sets the coating category of a coating document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetCategory(DocumentId inDocumentId, CoatingCategoryType inCoatingCategoryType)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
CoatingCategoryType	inCoatingCategoryType	The coating category.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetCoatingApperanceInfo(DocumentId, Boolean, Boolean, Boolean, Boolean)

Sets the coating apperance information.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetCoatingApperanceInfo(DocumentId inDocumentId, bool inReceiveShadows, bool inCastShadows, bool inFresnelReflection, bool inTransparentReflection)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Boolean	inReceiveShadows	Tells wether the coating receive shadows.
Boolean	inCastShadows	Tells wether the coating cast shadows.
Boolean	inFresnelReflection	Tells wether the coating has a frenesl reflection.
Boolean	inTransparentReflection	Tells wether the coating has transparent reflection.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetCoatingParameterValue(ElementId, PdmMinorRevisionId)

Sets value of a Coating Parameter

Declaration

[OperationContract]
[AvailableSinceVersion(7, 19, 400, 160)]
void SetCoatingParameterValue(ElementId inParameterId, PdmMinorRevisionId inPdmMinorRevisionId)

Parameters

Type	Name	Description
ElementId	inParameterId	The Id of the parameter
PdmMinorRevisionId	inPdmMinorRevisionId	MinorRevision of the document to use

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.19.400.160

SetDensity(DocumentId, Double)

Sets the coating density.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetDensity(DocumentId inDocumentId, double inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Double	inValue	Wanted value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetGlossinessFactor(DocumentId, Double)

Sets the Glossiness factor.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 18, 0, 0)]
void SetGlossinessFactor(DocumentId inDocumentId, double inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Double	inValue	Wanted value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.

SetGlossinessTextureDocument(DocumentId, DocumentId)

Sets the Glossiness texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 18, 0, 0)]
void SetGlossinessTextureDocument(DocumentId inDocumentId, DocumentId inTextureDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
DocumentId	inTextureDocumentId	Texture document.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.

SetMetalnessFactor(DocumentId, Double)

Sets the Metalness factor.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetMetalnessFactor(DocumentId inDocumentId, double inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Double	inValue	Wanted value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetMetalnessTextureDocument(DocumentId, DocumentId)

Sets the Metalness texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetMetalnessTextureDocument(DocumentId inDocumentId, DocumentId inTextureDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
DocumentId	inTextureDocumentId	Texture document.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetNormalFactor(DocumentId, Double)

Sets the Normal factor.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetNormalFactor(DocumentId inDocumentId, double inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Double	inValue	Wanted value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetNormalTextureDocument(DocumentId, DocumentId)

Sets the Normal texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetNormalTextureDocument(DocumentId inDocumentId, DocumentId inTextureDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
DocumentId	inTextureDocumentId	Texture document.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetOpacityColor(DocumentId, Color)

Sets the Opacity color.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetOpacityColor(DocumentId inDocumentId, Color inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Color	inValue	Wanted value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetOpacityTextureDocument(DocumentId, DocumentId)

Sets the Opacity texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetOpacityTextureDocument(DocumentId inDocumentId, DocumentId inTextureDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
DocumentId	inTextureDocumentId	Texture document.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetRefractiveIndex(DocumentId, Double)

Sets the refractive index.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetRefractiveIndex(DocumentId inDocumentId, double inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Double	inValue	Wanted value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetRotation(DocumentId, Double)

Sets the rotation.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetRotation(DocumentId inDocumentId, double inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Double	inValue	Wanted value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetRoughnessFactor(DocumentId, Double)

Sets the Roughness factor.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetRoughnessFactor(DocumentId inDocumentId, double inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Double	inValue	Wanted value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetRoughnessTextureDocument(DocumentId, DocumentId)

Sets the Roughness texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetRoughnessTextureDocument(DocumentId inDocumentId, DocumentId inTextureDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
DocumentId	inTextureDocumentId	Texture document.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetScale(DocumentId, Double)

Sets the scale.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetScale(DocumentId inDocumentId, double inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Double	inValue	Wanted value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetSpecularColor(DocumentId, Color)

Sets the Specular color.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 18, 0, 0)]
void SetSpecularColor(DocumentId inDocumentId, Color inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Color	inValue	Wanted value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.

SetSpecularTextureDocument(DocumentId, DocumentId)

Sets the Specular texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 18, 0, 0)]
void SetSpecularTextureDocument(DocumentId inDocumentId, DocumentId inTextureDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
DocumentId	inTextureDocumentId	Texture document.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.

SetTransmissionGlossinessFactor(DocumentId, Double)

Sets the Transmission Glossiness factor.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetTransmissionGlossinessFactor(DocumentId inDocumentId, double inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Double	inValue	Wanted value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetTransmissionGlossinessTextureDocument(DocumentId, DocumentId)

Sets the Transmission Glossiness texture document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetTransmissionGlossinessTextureDocument(DocumentId inDocumentId, DocumentId inTextureDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
DocumentId	inTextureDocumentId	Texture document.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetTransmissionScatteringColor(DocumentId, Color)

Sets the Transmission Scattering color.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetTransmissionScatteringColor(DocumentId inDocumentId, Color inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Color	inValue	Wanted color.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.

SetTransmissionScatteringLength(DocumentId, Double)

Sets the Transmission Scattering length.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetTransmissionScatteringLength(DocumentId inDocumentId, double inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Double	inValue	Wanted value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.16.