Interface ITextures

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

Namespace: TopSolid.Kernel.Automating

Assembly: cs.temp.dll.dll

Syntax

[AvailableSinceVersion(7, 16, 0, 0)]
public interface ITextures

Remarks

This interface is available since v7.16.

Methods

GetAngularScale(DocumentId)

Gets the angular scale.

Declaration

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

Parameters

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

Returns

Type	Description
System.Double

Remarks

This method must be called for Cylindrical or Spherical type.

This method is available since v7.16.

GetCategory(DocumentId)

Gets the texture category of a texture document.

Declaration

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

Parameters

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

Returns

Type	Description
TextureCategoryType	The texture category.

Remarks

This method is available since v7.16.

GetMapping(DocumentId)

Gets the texture mapping type of a texture document.

Declaration

[AvailableSinceVersion(7, 16, 0, 0)]
TextureMappingType GetMapping(DocumentId inDocumentId)

Parameters

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

Returns

Type	Description
TextureMappingType	The texture mapping type.

Remarks

This method is available since v7.16.

GetRedWayRotationAngle(DocumentId)

Gets the RedWay rotation angle.

Declaration

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

Parameters

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

Returns

Type	Description
System.Double

Remarks

This method is available since v7.16.

GetTextureScale(DocumentId)

Gets the texture scale.

Declaration

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

Parameters

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

Returns

Type	Description
System.Double

Remarks

This method is available since v7.16.

GetTransparentColor(DocumentId)

Gets the texture transparent color.

Declaration

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

Parameters

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

Returns

Type	Description
Color

Remarks

This method is available since v7.16.

GetVerticalAngularScale(DocumentId)

Gets the vertical angular scale.

Declaration

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

Parameters

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

Returns

Type	Description
System.Double

Remarks

This method must be called for Cylindrical or Spherical type.

This method is available since v7.16.

GetVerticalScale(DocumentId)

Gets the vertical scale.

Declaration

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

Parameters

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

Returns

Type	Description
System.Double

Remarks

This method must be called for Cylindrical or RedWay type.

This method is available since v7.16.

GetWoodColor(DocumentId)

Gets the wood color.

Declaration

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

Parameters

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

Returns

Type	Description
Color

Remarks

This method is available since v7.16.

GetWoodPerturbation(DocumentId)

Gets the wood perturbation or also called Gnarl.

Declaration

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

Parameters

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

Returns

Type	Description
System.Double

Remarks

This method is available since v7.16.

GetWoodRingColor(DocumentId)

Gets the wood ring color.

Declaration

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

Parameters

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

Returns

Type	Description
Color

Remarks

This method is available since v7.16.

GetWoodRingFuzzIn(DocumentId)

Gets the wood ring Fuzz-In.

Declaration

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

Parameters

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

Returns

Type	Description
System.Double

Remarks

This method is available since v7.16.

GetWoodRingFuzzOut(DocumentId)

Gets the wood ring Fuzz-Out.

Declaration

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

Parameters

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

Returns

Type	Description
System.Double

Remarks

This method is available since v7.16.

GetWoodRingWidth(DocumentId)

Gets the wood ring width.

Declaration

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

Parameters

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

Returns

Type	Description
System.Double

Remarks

This method is available since v7.16.

SetAngularScale(DocumentId, Double)

Sets the angular scale.

Declaration

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

Parameters

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

Remarks

This method must be called for Cylindrical or Spherical type.

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

This method is available since v7.16.

SetCategory(DocumentId, TextureCategoryType)

Sets the texture category of a texture document.

Declaration

[AvailableSinceVersion(7, 16, 0, 0)]
void SetCategory(DocumentId inDocumentId, TextureCategoryType inTextureCategoryType)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
TextureCategoryType	inTextureCategoryType	The texture category.

Remarks

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

This method is available since v7.16.

SetMapping(DocumentId, TextureMappingType)

Sets the texture mapping type of a texture document.

Declaration

[AvailableSinceVersion(7, 16, 0, 0)]
void SetMapping(DocumentId inDocumentId, TextureMappingType inMappingType)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
TextureMappingType	inMappingType	Type of the mapping.

Remarks

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

This method is available since v7.16.

SetPicture(DocumentId, String)

Sets the texture picture.

Declaration

[AvailableSinceVersion(7, 16, 0, 0)]
void SetPicture(DocumentId inDocumentId, string inPictureFullPath)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
System.String	inPictureFullPath	File path of the picture.

Remarks

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

This method is available since v7.16.

SetRedWayBumpFile(DocumentId, String)

Sets the redway bump file.

Declaration

[AvailableSinceVersion(7, 16, 0, 0)]
void SetRedWayBumpFile(DocumentId inDocumentId, string inFullPath)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
System.String	inFullPath	File path of the picture.

Remarks

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

This method is available since v7.16.

SetRedWayColorFile(DocumentId, String)

Sets the redway color file.

Declaration

[AvailableSinceVersion(7, 16, 0, 0)]
void SetRedWayColorFile(DocumentId inDocumentId, string inFullPath)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
System.String	inFullPath	File path of the picture.

Remarks

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

This method is available since v7.16.

SetRedWayRealisticFile(DocumentId, String)

Sets the redway realistic file.

Declaration

[AvailableSinceVersion(7, 16, 0, 0)]
void SetRedWayRealisticFile(DocumentId inDocumentId, string inFullPath)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
System.String	inFullPath	File path of the picture.

Remarks

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

This method is available since v7.16.

SetRedWayRealTimeFile(DocumentId, String)

Sets the redway real-time file.

Declaration

[AvailableSinceVersion(7, 16, 0, 0)]
void SetRedWayRealTimeFile(DocumentId inDocumentId, string inFullPath)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
System.String	inFullPath	File path of the picture.

Remarks

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

This method is available since v7.16.

SetRedWayRotationAngle(DocumentId, Double)

Sets the RedWay rotation angle.

Declaration

[AvailableSinceVersion(7, 16, 0, 0)]
void SetRedWayRotationAngle(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.

SetRedWaySpecularityFile(DocumentId, String)

Sets the redway specularity file.

Declaration

[AvailableSinceVersion(7, 16, 0, 0)]
void SetRedWaySpecularityFile(DocumentId inDocumentId, string inFullPath)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
System.String	inFullPath	File path of the picture.

Remarks

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

This method is available since v7.16.

SetRedWayTransparencyFile(DocumentId, String)

Sets the redway transparency file.

Declaration

[AvailableSinceVersion(7, 16, 0, 0)]
void SetRedWayTransparencyFile(DocumentId inDocumentId, string inFullPath)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
System.String	inFullPath	File path of the picture.

Remarks

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

This method is available since v7.16.

SetTextureScale(DocumentId, Double)

Sets the texture scale.

Declaration

[AvailableSinceVersion(7, 16, 0, 0)]
void SetTextureScale(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.

SetTransparentColor(DocumentId, Color)

Sets the texture transparent color.

Declaration

[AvailableSinceVersion(7, 16, 0, 0)]
void SetTransparentColor(DocumentId inDocumentId, Color inColor)

Parameters

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

Remarks

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

This method is available since v7.16.

SetVerticalAngularScale(DocumentId, Double)

Sets the vertical angular scale.

Declaration

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

Parameters

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

Remarks

This method must be called for Cylindrical or Spherical type.

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

This method is available since v7.16.

SetVerticalScale(DocumentId, Double)

Sets the vertical scale.

Declaration

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

Parameters

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

Remarks

This method must be called for Cylindrical or RedWay type.

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

This method is available since v7.16.

SetWoodColor(DocumentId, Color)

Sets the wood color.

Declaration

[AvailableSinceVersion(7, 16, 0, 0)]
void SetWoodColor(DocumentId inDocumentId, Color inColor)

Parameters

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

Remarks

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

This method is available since v7.16.

SetWoodPerturbation(DocumentId, Double)

Sets the wood perturbation or also called Gnarl.

Declaration

[AvailableSinceVersion(7, 16, 0, 0)]
void SetWoodPerturbation(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.

SetWoodRingColor(DocumentId, Color)

Sets the wood ring color.

Declaration

[AvailableSinceVersion(7, 16, 0, 0)]
void SetWoodRingColor(DocumentId inDocumentId, Color inColor)

Parameters

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

Remarks

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

This method is available since v7.16.

SetWoodRingFuzzIn(DocumentId, Double)

Sets the wood ring Fuzz-In.

Declaration

[AvailableSinceVersion(7, 16, 0, 0)]
void SetWoodRingFuzzIn(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.

SetWoodRingFuzzOut(DocumentId, Double)

Sets the wood ring Fuzz-Out.

Declaration

[AvailableSinceVersion(7, 16, 0, 0)]
void SetWoodRingFuzzOut(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.

SetWoodRingWidth(DocumentId, Double)

Sets the wood ring width.

Declaration

[AvailableSinceVersion(7, 16, 0, 0)]
void SetWoodRingWidth(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.