Interface IMultiLayer
Gives access to methods to read or write in a multi layer material document.
Namespace: TopSolid.Cad.Design.Automating
Assembly: TopSolid.Cad.Design.Automating.dll
Syntax
[ServiceContract]
[AvailableSinceVersion(7, 19, 0, 0)]
public interface IMultiLayerRemarks
This interface is available since v7.19.
Methods
AddMultiMaterialLayer(DocumentId, SmartMaterial, SmartReal, SmartReal)
Adds one layer to the layer list of the multimaterial document
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool AddMultiMaterialLayer(DocumentId inDocumentId, SmartMaterial inMaterial, SmartReal inThickness, SmartReal inOrientation)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
| SmartMaterial | inMaterial | Material |
| SmartReal | inThickness | Thickness |
| SmartReal | inOrientation | Orientation |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if layer has been added. |
Remarks
This method is available since v7.19.
GetBottomCoating(DocumentId)
Gets the multi layer bottom coating
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
SmartCoating GetBottomCoating(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
Returns
| Type | Description |
|---|---|
| SmartCoating | Null if not set or bottom as top |
Remarks
This method is available since v7.19.
GetBottomCoatingOrientationValue(DocumentId, out Real)
Gets the multi layer bottom coating orientation value
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool GetBottomCoatingOrientationValue(DocumentId inDocumentId, out Real outReal)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
| Real | outReal | Value in SI Units |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Remarks
This method is available since v7.19.
GetBottomFinishing(DocumentId)
Gets the multi layer bottom finishing
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
SmartFinishing GetBottomFinishing(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
Returns
| Type | Description |
|---|---|
| SmartFinishing | Null if not set or bottom as top |
Remarks
This method is available since v7.19.
GetBottomFinishingOrientationValue(DocumentId, Real)
Gets the multi layer bottom finishing orientation value
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool GetBottomFinishingOrientationValue(DocumentId inDocumentId, Real outReal)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
| Real | outReal | Value in SI Units |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Remarks
This method is available since v7.19.
GetCategory(DocumentId)
Gets the multi layer material category of a multi layer material document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
MultiLayerMaterialCategoryType GetCategory(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| MultiLayerMaterialCategoryType | The multi layer material category. |
Remarks
This method is available since v7.19.
GetDescription(DocumentId)
Gets the multi layer material document description
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
string GetDescription(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| System.String | The multi layer material description. |
Remarks
This method is available since v7.19.
GetEnveloppeMaterial(DocumentId)
Gets the multi layer enveloppe material
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
SmartMaterial GetEnveloppeMaterial(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
Returns
| Type | Description |
|---|---|
| SmartMaterial |
Remarks
This method is available since v7.19.
GetHomogeneousParameterValue(DocumentId, out Nullable<Boolean>)
Gets the multi layer material Homogeneous Parameter
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
void GetHomogeneousParameterValue(DocumentId inDocumentId, out bool? outValue)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document. |
| System.Nullable<System.Boolean> | outValue | Value |
Remarks
This method is available since v7.19.
GetIsotropicParameterValue(DocumentId, out Nullable<Boolean>)
Gets the multi layer material Isotropic Parameter
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
void GetIsotropicParameterValue(DocumentId inDocumentId, out bool? outValue)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document. |
| System.Nullable<System.Boolean> | outValue | Value |
Remarks
This method is available since v7.19.
GetMultiLayerMaterialDocumentDetailedBitmap(DocumentId, Int32, Int32)
Gets multi layer document layer preview bitmap
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
Bitmap GetMultiLayerMaterialDocumentDetailedBitmap(DocumentId inDocumentId, int inWidth, int inHeight)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
| System.Int32 | inWidth | Bitmap width in pixels |
| System.Int32 | inHeight | Bitmap height in pixels |
Returns
| Type | Description |
|---|---|
| System.Drawing.Bitmap | preview bitmap. |
Remarks
This method is available since v7.19.
GetMultiLayerMaterialDocumentEnveloppeBitmap(DocumentId, Int32, Int32)
Gets multi layer document layer enveloppe bitmap
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
Bitmap GetMultiLayerMaterialDocumentEnveloppeBitmap(DocumentId inDocumentId, int inWidth, int inHeight)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
| System.Int32 | inWidth | Bitmap width in pixels |
| System.Int32 | inHeight | Bitmap height in pixels |
Returns
| Type | Description |
|---|---|
| System.Drawing.Bitmap | enveloppe bitmap. |
Remarks
This method is available since v7.19.
GetMultiLayerTotalThickness(DocumentId)
Gets the multi layer total thickness
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
Real GetMultiLayerTotalThickness(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
Returns
| Type | Description |
|---|---|
| Real | total thickness |
Remarks
This method is available since v7.19.
GetMultiMaterialLayers(DocumentId, out List<SmartMaterial>, out List<SmartReal>, out List<SmartReal>)
Gets the multi layer layers
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool GetMultiMaterialLayers(DocumentId inDocumentId, out List<SmartMaterial> outMaterials, out List<SmartReal> outThicknesses, out List<SmartReal> outOrientations)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
| System.Collections.Generic.List<SmartMaterial> | outMaterials | Materials, from top to bottom |
| System.Collections.Generic.List<SmartReal> | outThicknesses | Thicknesses, from top to bottom |
| System.Collections.Generic.List<SmartReal> | outOrientations | Orientations, from top to bottom |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if data has been collected with success. |
Remarks
This method is available since v7.19.
GetMultiMaterialLayersCount(DocumentId)
Gets the multi layer layers count
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
int GetMultiMaterialLayersCount(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
Returns
| Type | Description |
|---|---|
| System.Int32 | the number of layers |
Remarks
This method is available since v7.19.
GetPartNumber(DocumentId)
Gets the multi layer material document part number
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
string GetPartNumber(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| System.String | The multi layer material part number. |
Remarks
This method is available since v7.19.
GetTopCoating(DocumentId)
Gets the multi layer top coating
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
SmartCoating GetTopCoating(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
Returns
| Type | Description |
|---|---|
| SmartCoating |
Remarks
This method is available since v7.19.
GetTopCoatingOrientationValue(DocumentId, out Real)
Gets the multi layer top coating orientation value
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool GetTopCoatingOrientationValue(DocumentId inDocumentId, out Real outReal)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
| Real | outReal | Value in SI Units |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Remarks
This method is available since v7.19.
GetTopFinishing(DocumentId)
Gets the multi layer top finishing
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
SmartFinishing GetTopFinishing(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
Returns
| Type | Description |
|---|---|
| SmartFinishing |
Remarks
This method is available since v7.19.
GetTopFinishingOrientationValue(DocumentId, out Real)
Gets the multi layer top finishing orientation value
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool GetTopFinishingOrientationValue(DocumentId inDocumentId, out Real outReal)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
| Real | outReal | Value in SI Units |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Remarks
This method is available since v7.19.
IsBottomCoatingLikeTop(DocumentId)
Tells if bottom coating is like top
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool? IsBottomCoatingLikeTop(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
Returns
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> | True if bottom is like top, otherwise false |
Remarks
This method is available since v7.19.
IsBottomFinishingLikeTop(DocumentId)
Tells if bottom finishing is like top
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool? IsBottomFinishingLikeTop(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
Returns
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> | True if bottom is like top, otherwise false |
Remarks
This method is available since v7.19.
RemoveMultiMaterialLayer(DocumentId, Int32)
Remove one layer from the layer list of the multimaterial document
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool RemoveMultiMaterialLayer(DocumentId inDocumentId, int inLayerIndex)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
| System.Int32 | inLayerIndex | Index of the layer to remove |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if layer has been removed. |
Remarks
This method is available since v7.19.
SetBottomCoating(DocumentId, SmartCoating)
Sets the multi layer bottom coating
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool SetBottomCoating(DocumentId inDocumentId, SmartCoating inSmartCoating)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
| SmartCoating | inSmartCoating | Smart Coating |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if value is correctly set. |
Remarks
This method is available since v7.19.
SetBottomCoatingLikeTop(DocumentId, Boolean)
Sets bottom coating as top boolean value
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool SetBottomCoatingLikeTop(DocumentId inDocumentId, bool inValue)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
| System.Boolean | inValue | Value to use |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if value has been set with success. |
Remarks
This method is available since v7.19.
SetBottomCoatingOrientationValue(DocumentId, Real)
Sets the multi layer bottom coating orientation value
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool SetBottomCoatingOrientationValue(DocumentId inDocumentId, Real inReal)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify |
| Real | inReal | Value in SI Units |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if value is correctly set. |
Remarks
This method is available since v7.19.
SetBottomFinishing(DocumentId, SmartFinishing)
Sets the multi layer bottom finishing
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool SetBottomFinishing(DocumentId inDocumentId, SmartFinishing inSmartCoating)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
| SmartFinishing | inSmartCoating | Smart Finishing |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if value is correctly set. |
Remarks
This method is available since v7.19.
SetBottomFinishingLikeTop(DocumentId, Boolean)
Sets bottom finishing as top boolean value
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool SetBottomFinishingLikeTop(DocumentId inDocumentId, bool inValue)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
| System.Boolean | inValue | Value to use |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if value has been set with success. |
Remarks
This method is available since v7.19.
SetBottomFinishingOrientationValue(DocumentId, Real)
Sets the multi layer bottom finishing orientation value
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool SetBottomFinishingOrientationValue(DocumentId inDocumentId, Real inReal)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify |
| Real | inReal | Value in SI Units |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if value is correctly set. |
Remarks
This method is available since v7.19.
SetCategory(DocumentId, MultiLayerMaterialCategoryType)
Sets the multi layer material category of a material document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
void SetCategory(DocumentId inDocumentId, MultiLayerMaterialCategoryType inMultiLayerMaterialCategoryType)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| MultiLayerMaterialCategoryType | inMultiLayerMaterialCategoryType | The multi layer material category. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.19.
SetDescription(DocumentId, String)
Sets the multi layer material document description
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool SetDescription(DocumentId inDocumentId, string inDescription)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| System.String | inDescription | Description value. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if value is correctly set. |
Remarks
This method is available since v7.19.
SetEnveloppeMaterial(DocumentId, SmartMaterial)
Sets the multi layer enveloppe material
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool SetEnveloppeMaterial(DocumentId inDocumentId, SmartMaterial inSmartMaterial)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
| SmartMaterial | inSmartMaterial | Smart Material |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if value is correctly set. |
Remarks
This method is available since v7.19.
SetHomogeneousParameterValue(DocumentId, Boolean)
Sets the multi layer material Homogeneous Parameter
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool SetHomogeneousParameterValue(DocumentId inDocumentId, bool isHomogeneous)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| System.Boolean | isHomogeneous | Value |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if value is correctly set. |
Remarks
This method is available since v7.19.
SetIsotropicParameterValue(DocumentId, Boolean)
Sets the multi layer material Isotropic Parameter
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool SetIsotropicParameterValue(DocumentId inDocumentId, bool isIsotroPic)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| System.Boolean | isIsotroPic | Value |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if value is correctly set. |
Remarks
This method is available since v7.19.
SetMultiMaterialLayers(DocumentId, List<SmartMaterial>, List<SmartReal>, List<SmartReal>)
Adds one layer to the layer list of the multimaterial document
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
void SetMultiMaterialLayers(DocumentId inDocumentId, List<SmartMaterial> inMaterials, List<SmartReal> inThicknesses, List<SmartReal> inOrientations)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
| System.Collections.Generic.List<SmartMaterial> | inMaterials | List of Materials from top to bottom |
| System.Collections.Generic.List<SmartReal> | inThicknesses | List of Thicknesses from top to bottom |
| System.Collections.Generic.List<SmartReal> | inOrientations | List of Orientations from top to bottom |
Remarks
This method is available since v7.19.
SetPartNumber(DocumentId, String)
Sets the multi layer material part number
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool SetPartNumber(DocumentId inDocumentId, string inPartNumber)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| System.String | inPartNumber | Part Number. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if value is correctly set. |
Remarks
This method is available since v7.19.
SetTopCoating(DocumentId, SmartCoating)
Sets the multi layer top coating
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool SetTopCoating(DocumentId inDocumentId, SmartCoating inSmartCoating)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
| SmartCoating | inSmartCoating | Smart Coating |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if value is correctly set. |
Remarks
This method is available since v7.19.
SetTopCoatingOrientationValue(DocumentId, Real)
Sets the multi layer top coating orientation value
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool SetTopCoatingOrientationValue(DocumentId inDocumentId, Real inReal)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify |
| Real | inReal | Value in SI Units |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if value is correctly set. |
Remarks
This method is available since v7.19.
SetTopFinishing(DocumentId, SmartFinishing)
Sets the multi layer top finishing
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool SetTopFinishing(DocumentId inDocumentId, SmartFinishing inSmartFinishing)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document |
| SmartFinishing | inSmartFinishing | Smart Finishing |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if value is correctly set. |
Remarks
This method is available since v7.19.
SetTopFinishingOrientationValue(DocumentId, Real)
Sets the multi layer top finishing orientation value
Declaration
[OperationContract]
[AvailableSinceVersion(7, 19, 0, 0)]
bool SetTopFinishingOrientationValue(DocumentId inDocumentId, Real inReal)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify |
| Real | inReal | Value in SI Units |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if value is correctly set. |
Remarks
This method is available since v7.19.