Material Controller

interface ICwAPI3DMaterialController

Public Functions

virtual ICwAPI3DString *getLastError(int32_t *aErrorCode) = 0

Gets the last error message.

Parameters:: aErrorCode – [out] [int32_t*] A pointer to an integer where the error code will be stored.
Returns:: [ICwAPI3DString*] A string containing the last error message.

virtual materialID createMaterial(const character *aName) = 0

Creates new material.

Parameters:: aName – [in] [const character*] The material name.
Returns:: [materialID] The material id.

virtual ICwAPI3DString *getName(materialID aMaterialId) = 0

Gets the material name.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [ICwAPI3DString*] The material name.

virtual void setName(materialID aMaterialId, const character *aName) = 0

Sets the material name.

Parameters:

aMaterialId – [in] [materialID] The material id.
aName – [in] [const character*] The material name.

virtual ICwAPI3DString *getGroup(materialID aMaterialId) = 0

Gets the material group.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [ICwAPI3DString*] The material group.

virtual void setGroup(materialID aMaterialId, const character *aGroup) = 0

Sets the material group.

Parameters:

aMaterialId – [in] [materialID] The material id.
aGroup – [in] [const character*] The material group.

virtual ICwAPI3DString *getCode(materialID aMaterialId) = 0

Gets the material code.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [ICwAPI3DString*] The material code.

virtual void setCode(materialID aMaterialId, const character *aCode) = 0

Sets the material code.

Parameters:

aMaterialId – [in] [materialID] The material id.
aCode – [in] [const character*] The material code.

virtual double getModulusElasticity1(materialID aMaterialId) = 0

Gets the material modulus of elasticity 1.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [double] The material modulus of elasticity 1.

virtual void setModulusElasticity1(materialID aMaterialId, double aModulusElasticity1) = 0

Sets the material modulus of elasticity 1.

Parameters:

aMaterialId – [in] [materialID] The material id.
aModulusElasticity1 – [in] [double] The material modulus of elasticity 1.

virtual double getModulusElasticity2(materialID aMaterialId) = 0

Gets the material modulus of elasticity 2.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [double] The material modulus of elasticity 2.

virtual void setModulusElasticity2(materialID aMaterialId, double aModulusElasticity2) = 0

Sets the material modulus of elasticity 2.

Parameters:

aMaterialId – [in] [materialID] The material id.
aModulusElasticity2 – [in] [double] The material modulus of elasticity 2.

virtual double getModulusElasticity3(materialID aMaterialId) = 0

Gets the material modulus of elasticity 3.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [double] The material modulus of elasticity 3.

virtual void setModulusElasticity3(materialID aMaterialId, double aModulusElasticity3) = 0

Sets the material modulus of elasticity 3.

Parameters:

aMaterialId – [in] [materialID] The material id.
aModulusElasticity3 – [in] [double] The material modulus of elasticity 3.

virtual double getShearModulus1(materialID aMaterialId) = 0

Gets the material shear modulus 1.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [double] The material shear modulus 1.

virtual void setShearModulus1(materialID aMaterialId, double aShearModulus1) = 0

Sets the material shear modulus 1.

Parameters:

aMaterialId – [in] [materialID] The material id.
aShearModulus1 – [in] [double] The material shear modulus 1.

virtual double getShearModulus2(materialID aMaterialId) = 0

Gets the material shear modulus 2.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [double] The material shear modulus 2.

virtual void setShearModulus2(materialID aMaterialId, double aShearModulus2) = 0

Sets the material shear modulus 2.

Parameters:

aMaterialId – [in] [materialID] The material id.
aShearModulus2 – [in] [double] The material shear modulus 2.

virtual double getPrice(materialID aMaterialId) = 0

Gets the material price.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [double] The material price.

virtual void setPrice(materialID aMaterialId, double aPrice) = 0

Sets the material price.

Parameters:

aMaterialId – [in] [materialID] The material id.
aPrice – [in] [double] The material price.

virtual ICwAPI3DString *getPriceType(materialID aMaterialId) = 0

Gets the material price type.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [ICwAPI3DString*] The material price type.

virtual void setPriceType(materialID aMaterialId, const character *aPriceType) = 0

Sets the material price type.

Parameters:

aMaterialId – [in] [materialID] The material id.
aPriceType – [in] [const character*] The material price type.

virtual double getThermalConductivity(materialID aMaterialId) = 0

Gets the material thermal conductivity.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [double] The material thermal conductivity.

virtual void setThermalConductivity(materialID aMaterialId, double aThermalConductivity) = 0

Sets the material thermal conductivity.

Parameters:

aMaterialId – [in] [materialID] The material id.
aThermalConductivity – [in] [double] The material thermal conductivity.

virtual double getHeatCapacity(materialID aMaterialId) = 0

Gets the material heat capacity.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [double] The material heat capacity.

virtual void setHeatCapacity(materialID aMaterialId, double aHeatCapacity) = 0

Sets the material heat capacity.

Parameters:

aMaterialId – [in] [materialID] The material id.
aHeatCapacity – [in] [double] The material heat capacity.

virtual double getUMin(materialID aMaterialId) = 0

Gets the material U min.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [double] The material U min.

virtual void setUMin(materialID aMaterialId, double aUMin) = 0

Sets the material U min.

Parameters:

aMaterialId – [in] [materialID] The material id.
aUMin – [in] [double] The material U min.

virtual double getUMax(materialID aMaterialId) = 0

Gets the material U max.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [double] The material U max.

virtual void setUMax(materialID aMaterialId, double aUMax) = 0

Sets the material U max.

Parameters:

aMaterialId – [in] [materialID] The material id.
aUMax – [in] [double] The material U max.

virtual ICwAPI3DString *getFireResistanceClass(materialID aMaterialId) = 0

Gets the material fire resistance class.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [ICwAPI3DString*] The material fire resistance class.

virtual void setFireResistanceClass(materialID aMaterialId, const character *aFireResistanceClass) = 0

Sets the material fire resistance class.

Parameters:

aMaterialId – [in] [materialID] The material id.
aFireResistanceClass – [in] [const character*] The material fire resistance class.

virtual ICwAPI3DString *getSmokeClass(materialID aMaterialId) = 0

Gets the material smoke class.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [ICwAPI3DString*] The material smoke class.

virtual void setSmokeClass(materialID aMaterialId, const character *aSmokeClass) = 0

Sets the material smoke class.

Parameters:

aMaterialId – [in] [materialID] The material id.
aSmokeClass – [in] [const character*] The material smoke class.

virtual ICwAPI3DString *getDropFormingClass(materialID aMaterialId) = 0

Gets the material drop forming class.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [ICwAPI3DString*] The material drop forming class.

virtual void setDropFormingClass(materialID aMaterialId, const character *aDropFormingClass) = 0

Sets the material drop forming class.

Parameters:

aMaterialId – [in] [materialID] The material id.
aDropFormingClass – [in] [const character*] The material drop forming class.

virtual double getBurnOffRate(materialID aMaterialId) = 0

Gets the material burn-off rate.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [double] The material burn off rate.

virtual void setBurnOffRate(materialID aMaterialId, double aBurnOffRate) = 0

Sets the material burn-off rate.

Parameters:

aMaterialId – [in] [materialID] The material id.
aBurnOffRate – [in] [double] The material burn off rate.

virtual double getWeight(materialID aMaterialId) = 0

Gets the material weight.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [double] The material weight.

virtual void setWeight(materialID aMaterialId, double aWeight) = 0

Sets the material weight.

Parameters:

aMaterialId – [in] [materialID] The material id.
aWeight – [in] [double] The material weight.

virtual ICwAPI3DString *getWeightType(materialID aMaterialId) = 0

Gets the material weight type.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [ICwAPI3DString*] The material weight type.

virtual void setWeightType(materialID aMaterialId, const character *aWeightType) = 0

Sets the material weight type.

Parameters:

aMaterialId – [in] [materialID] The material id.
aWeightType – [in] [const character*] The material weight type.

virtual materialID getMaterialID(const character *aMaterialName) = 0

Gets the material with a given name.

Parameters:: aMaterialName – [in] [const character*] The material name.
Returns:: [materialID] The material id.

virtual ICwAPI3DMaterialIDList *getAllMaterials() = 0

Retrieves a list of all materials.

Returns:: [ICwAPI3DMaterialIDList*] A list of all material id.

virtual void clearErrors() = 0: Clears all errors.

virtual ICwAPI3DString *getGrade(materialID aMaterialId) = 0

Gets the grade of a material.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [ICwAPI3DString*] The grade of the material.

virtual void setGrade(materialID aMaterialId, const character *aGrade) = 0

Sets the grade of a material.

Parameters:

aMaterialId – [in] [materialID] The material id.
aGrade – [in] [const character*] The grade to set.

virtual ICwAPI3DString *getQuality(materialID aMaterialId) = 0

Gets the quality of a material.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [ICwAPI3DString*] The quality of the material.

virtual void setQuality(materialID aMaterialId, const character *aQuality) = 0

Sets the quality of a material.

Parameters:

aMaterialId – [in] [materialID] The material id.
aQuality – [in] [const character*] The quality to set.

virtual ICwAPI3DString *getComposition(materialID aMaterialId) = 0

Gets the composition of a material.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [ICwAPI3DString*] The composition of the material.

virtual void setComposition(materialID aMaterialId, const character *aComposition) = 0

Sets the composition of a material.

Parameters:

aMaterialId – [in] [materialID] The material id.
aComposition – [in] [const character*] The composition to set.

virtual ICwAPI3DString *getShortName(materialID aMaterialId) = 0

Gets the short name of a material.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [ICwAPI3DString*] The short name of the material.

virtual ICwAPI3DStringList *getAllMaterialGroups() = 0

Retrieves a list of all material groups.

Returns:: [ICwAPI3DStringList*] A list of all material group names.

virtual ICwAPI3DString *getParentGroup(const character *aGroup) = 0

Gets the parent group of a given group.

Parameters:: aGroup – [in] [const character*] The name of the group.
Returns:: [ICwAPI3DString*] The name of the parent group.

virtual materialID getMaterialColorAssignmentForNodes(uint32_t aColorNumber) = 0

Gets the material color assignment for nodes.

Parameters:: aColorNumber – [in] [uint32_t] The color number. [1-255]
Returns:: [materialID] The material id assigned to the color number for nodes.

virtual void setMaterialColorAssignmentForNodes(uint32_t aColorNumber, materialID aMaterial) = 0

Sets the material color assignment for nodes.

Parameters:

aColorNumber – [in] [uint32_t] The color number. [1-255]
aMaterial – [in] [materialID] The material ID to assign to the color number for nodes.

virtual materialID getMaterialColorAssignmentForStandardAxes(uint32_t aColorNumber) = 0

Gets the material color assignment for standard axes.

Parameters:: aColorNumber – [in] [uint32_t] The color number. [1-255]
Returns:: [materialID] The material id assigned to the color number for standard axes.

virtual void setMaterialColorAssignmentForStandardAxes(uint32_t aColorNumber, materialID aMaterial) = 0

Sets the material color assignment for standard axes.

Parameters:

aColorNumber – [in] [uint32_t] The color number. [1-255]
aMaterial – [in] [materialID] The material ID to assign to the color number for standard axes.

virtual materialID getMaterialColorAssignmentForDrillings(uint32_t aColorNumber) = 0

Gets the material color assignment for drillings.

Parameters:: aColorNumber – [in] [uint32_t] The color number. [1-255]
Returns:: [materialID] The material id assigned to the color number for drillings.

virtual void setMaterialColorAssignmentForDrillings(uint32_t aColorNumber, materialID aMaterial) = 0

Sets the material color assignment for drillings.

Parameters:

aColorNumber – [in] [uint32_t] The color number. [1-255]
aMaterial – [in] [materialID] The material ID to assign to the color number for drillings.

virtual materialID getMaterialColorAssignmentForMEPAxes(uint32_t aColorNumber) = 0

Gets the material color assignment for MEP axes.

Parameters:: aColorNumber – [in] [uint32_t] The color number. [1-255]
Returns:: [materialID] The material id assigned to the color number for MEP axes.

virtual void setMaterialColorAssignmentForMEPAxes(uint32_t aColorNumber, materialID aMaterial) = 0

Sets the material color assignment for MEP axes.

Parameters:

aColorNumber – [in] [uint32_t] The color number. [1-255]
aMaterial – [in] [materialID] The material ID to assign to the color number for MEP axes.

virtual materialID getMaterialColorAssignmentForBeams(uint32_t aColorNumber) = 0

Gets the material color assignment for beams.

Parameters:: aColorNumber – [in] [uint32_t] The color number. [1-255]
Returns:: [materialID] The material id assigned to the color number for beams.

virtual void setMaterialColorAssignmentForBeams(uint32_t aColorNumber, materialID aMaterial) = 0

Sets the material color assignment for beams.

Parameters:

aColorNumber – [in] [uint32_t] The color number. [1-255]
aMaterial – [in] [materialID] The material ID to assign to the color number for beams.

virtual materialID getMaterialColorAssignmentForPanels(uint32_t aColorNumber) = 0

Gets the material color assignment for panels.

Parameters:: aColorNumber – [in] [uint32_t] The color number. [1-255]
Returns:: [materialID] The material id assigned to the color number for panels.

virtual void setMaterialColorAssignmentForPanels(uint32_t aColorNumber, materialID aMaterial) = 0

Sets the material color assignment for panels.

Parameters:

aColorNumber – [in] [uint32_t] The color number. [1-255]
aMaterial – [in] [materialID] The material ID to assign to the color number for panels.

virtual materialID getMaterialColorAssignmentForAuxiliaryElements(uint32_t aColorNumber) = 0

Gets the material color assignment for auxiliary elements.

Parameters:: aColorNumber – [in] [uint32_t] The color number. [1-255]
Returns:: [materialID] The material id assigned to the color number for auxiliary elements.

virtual void setMaterialColorAssignmentForAuxiliaryElements(uint32_t aColorNumber, materialID aMaterial) = 0

Sets the material color assignment for auxiliary elements.

Parameters:

aColorNumber – [in] [uint32_t] The color number. [1-255]
aMaterial – [in] [materialID] The material ID to assign to the color number for auxiliary elements.

virtual materialID getMaterialColorAssignmentForSurfaces(uint32_t aColorNumber) = 0

Gets the material color assignment for surfaces.

Parameters:: aColorNumber – [in] [uint32_t] The color number. [1-255]
Returns:: [materialID] The material id assigned to the color number for surfaces.

virtual void setMaterialColorAssignmentForSurfaces(uint32_t aColorNumber, materialID aMaterial) = 0

Sets the material color assignment for surfaces.

Parameters:

aColorNumber – [in] [uint32_t] The color number. [1-255]
aMaterial – [in] [materialID] The material ID to assign to the color number for surfaces.

virtual int32_t getTextureColor(materialID aMaterialId) = 0

Gets the texture color for a given material ID.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [int32_t] The color of the texture. [1-255]

virtual void setTextureColor(materialID aMaterialId, int32_t aColor) = 0

Sets the texture color for a given material ID.

Parameters:

aMaterialId – [in] [materialID] The material id.
aColor – [in] [int32_t] The color to set for the texture. [1-255]

virtual int32_t getTextureTransparency(materialID aMaterialId) = 0

Gets the texture transparency for a given material ID.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [int32_t] The transparency of the texture.

virtual void setTextureTransparency(materialID aMaterialId, int32_t aTransparency) = 0

Sets the texture transparency for a given material ID.

Parameters:

aMaterialId – [in] [materialID] The material id.
aTransparency – [in] [int32_t] The transparency to set for the texture.

virtual double getTextureRotationAngle(materialID aMaterialId) = 0

Gets the texture rotation angle for a given material ID.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [double] The rotation angle of the texture.

virtual void setTextureRotationAngle(materialID aMaterialId, double aAngle) = 0

Sets the texture rotation angle for a given material ID.

Parameters:

aMaterialId – [in] [materialID] The material id.
aAngle – [in] [double] The rotation angle to set for the texture.

virtual bool getTextureLengthAlignment(materialID aMaterialId) = 0

Gets the texture length alignment for a given material ID.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [bool] True if Texture Random Placement is enabled, false otherwise.

virtual void setTextureLengthAlignment(materialID aMaterialId, bool aLengthAlignment) = 0

Sets the texture length alignment for a given material ID.

Parameters:

aMaterialId – [in] [materialID] The material id.
aLengthAlignment – [in] [bool] True if Texture Random Placement is enabled, false otherwise.

virtual double getTextureZoomX(materialID aMaterialId) = 0

Gets the texture zoom factor in the X direction for a given material ID.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [double] The zoom factor of the texture in the X direction.

virtual void setTextureZoomX(materialID aMaterialId, double aValue) = 0

Sets the texture zoom factor in the X direction for a given material ID.

Parameters:

aMaterialId – [in] [materialID] The material id.
aValue – [in] [double] The zoom factor to set in the X direction.

virtual double getTextureZoomY(materialID aMaterialId) = 0

Gets the texture zoom factor in the Y direction for a given material ID.

Parameters:: aMaterialId – [in] [materialID] The material id.
Returns:: [double] The zoom factor of the texture in the Y direction.

virtual void setTextureZoomY(materialID aMaterialId, double aValue) = 0

Sets the texture zoom factor in the Y direction for a given material ID.

Parameters:

aMaterialId – [in] [materialID] The material id.
aValue – [in] [double] The zoom factor to set.