Interface IMaterials

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

Namespace: TopSolid.Cad.Design.Automating

Assembly: TopSolid.Cad.Design.Automating.dll

Syntax

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

Remarks

This interface is available since v7.16.

Methods

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
System.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.

GetCategory(DocumentId)

Gets the material category of a material document.

Declaration

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

Parameters

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

Returns

Type	Description
MaterialCategoryType	The material category.

Remarks

This method is available since v7.16.

GetDensity(DocumentId)

Gets the material 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
System.Double

Remarks

This method is available since v7.16.

GetHatchingDocument(DocumentId)

Gets the hatching document to a material document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 400, 100)]
DocumentId GetHatchingDocument(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.

GetMaterialApperanceInfo(DocumentId, Boolean, Boolean, Boolean, Boolean)

Gets the material apperance information.

Declaration

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

Parameters

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

Remarks

This method is available since v7.16.

GetMaterialModel(DocumentId)

Gets the material model of a material document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
MaterialModelType GetMaterialModel(DocumentId inDocumentId)

Parameters

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

Returns

Type	Description
MaterialModelType	The material model.

Remarks

This method is available since v7.16.

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
System.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
System.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
System.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
System.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
System.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
System.Double

Remarks

This method is available since v7.16.

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
System.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
System.Double

Remarks

This method is available since v7.16.

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.
System.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.

SetCategory(DocumentId, MaterialCategoryType)

Sets the material category of a material document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetCategory(DocumentId inDocumentId, MaterialCategoryType inMaterialCategoryType)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
MaterialCategoryType	inMaterialCategoryType	The material category.

Remarks

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

This method is available since v7.16.

SetDensity(DocumentId, Double)

Sets the material 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.
System.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.

SetHatchingDocument(DocumentId, DocumentId)

Sets the hatching document to a material document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
void SetHatchingDocument(DocumentId inDocumentId, DocumentId inHatchingDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
DocumentId	inHatchingDocumentId	The hatching document.

Remarks

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

This method is available since v7.16.

SetMaterialApperanceInfo(DocumentId, Boolean, Boolean, Boolean, Boolean)

Sets the material apperance information.

Declaration

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

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
System.Boolean	inReceiveShadows	Tells wether the material receive shadows.
System.Boolean	inCastShadows	Tells wether the material cast shadows.
System.Boolean	inFresnelReflection	Tells wether the material has a frenesl reflection.
System.Boolean	inTransparentReflection	Tells wether the material 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.

SetMaterialModel(DocumentId, MaterialModelType)

Sets the material model of a material document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 18, 400, 160)]
void SetMaterialModel(DocumentId inDocumentId, MaterialModelType inModel)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
MaterialModelType	inModel	The material model.

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.
System.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.
System.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.
System.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.
System.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.
System.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.
System.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.

SetTextureMapping(DocumentId, TextureMappingType)

Sets the texture mapping of a material document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 19, 331, 0)]
void SetTextureMapping(DocumentId inDocumentId, TextureMappingType inTextureMappingType)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
TextureMappingType	inTextureMappingType	The texture mapping.

Remarks

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

This method is available since v7.19.

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.
System.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.
System.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.