Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

CmaterialPointer.

Methods

NameDescription
setName Sets coating name.
getName Gets coating name.
setState 

Enables/disables the coating.

getState Gets whether the coating is enabled.
getReflectance Gets a reference of the Cmaxwell::Creflectance of this coating.
setThickness Sets the thickness of the coating.
getThickness Gets the thickness of the coating.
setActiveThickness Sets the active thickness of the coating.
getActiveThickness Gets the active thickness of the coating.
setThicknessRange Sets the thickness range.
getThicknessRange Gets the thickness range.

Inherited methods

NameDescription
isNullChecks whether the object is null.

Anchor
setname
setname

setName

Sets coating name.

LanguageSyntax
C++byte setName( const char* pName )
Pythonint setName( str name )

Return value

0 = Error getting coating name.

1 = Success.

Anchor
getname
getname

getName

Gets coating name.

LanguageSyntax
C++byte getName( char** pName )
Pythonstr getName()

Return Value

C++

0 = Error getting coating name.

1 = Success.

Python

Coating name.

Anchor
setstate
setstate

setState

Enables/disables the coating.

LanguageSyntax
C++byte setState( bool enabled )
Pythonint setState( bool enabled )

Return value

0 = Error enabling/disabling coating.

1 = Success.

Anchor
getstate
getstate

getState

Gets whether the coating is enabled.

LanguageSyntax
C++byte getState( bool& enabled )
Pythonbool getState()

Return Value

C++

0 = Error getting coating enabled state.

1 = Success.

Python

Coating enabled state.

Anchor
getreflectance
getreflectance

getReflectance

Gets a reference of the Cmaxwell::Creflectance of this coating.

LanguageSyntax
C++Cmaxwell::Creflectance getReflectance()
PythonCreflectance getReflectance()

Anchor
setthickness
setthickness

setThickness

Sets the thickness of the coating.

LanguageSyntax
C++byte setThickness( Cmultivalue::Cmap& map )
Pythonint setThickness( Cmap map )

Return value

0 = Error setting thickness.

1 = Success.

Anchor
getthickness
getthickness

getThickness

Gets the thickness of the coating.

LanguageSyntax
C++byte getThickness( Cmultivalue::Cmap & map )
PythonCmap getThickness()

Return Value

C++

0 = Error getting thickness.

1 = Success.

Python

Coating thickness.

Anchor
setactivethickness
setactivethickness

setActiveThickness

Sets the active thickness of the coating.

LanguageSyntax
C++byte setActiveThickness( Cmultivalue::Cmap& map )
Pythonint setActiveThickness( Cmap map )

Return value

0 = Error setting active thickness.

1 = Success.

Anchor
getactivethickness
getactivethickness

getActiveThickness

Gets the active thickness of the coating.

LanguageSyntax
C++byte getActiveThickness( Cmultivalue::Cmap & map )
PythonCmap getActiveThickness()

Return Value

C++

0 = Error getting active thickness.

1 = Success.

Python

Coating active thickness.

Anchor
setthicknessrange
setthicknessrange

setThicknessRange

Sets the thickness range of the coating.

LanguageSyntax
C++byte setThicknessRange( real min, real  max )
Pythonint setThicknessRange( float min, float max )

Return value

0 = Error setting thickness range.

1 = Success.

Anchor
getthicknessrange
getthicknessrange

getThicknessRange

Gets the active thickness of the coating.

LanguageSyntax
C++byte getThicknessRange( real & min, real& max )
Python(min,max) getThicknessRange()

Return Value

C++

0 = Error getting thickness range.

1 = Success.

Python

Tuple (min,max) containing thickness range.