pycatia.cat_rma_interfaces.rendering_material

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.cat_rma_interfaces.rendering_material.RenderingMaterial(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
RenderingMaterial

Represents an RenderingMaterial object.
This object is used to manage the Rendering properties of a
material.
property adaptive_coeff: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property AdaptiveCoeff() As short

Returns or sets the adaptive coefficient of a material. Adaptive coefficient
value is between 1 an 8.
Return type:

int

property ambient_coefficient: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property AmbientCoefficient() As double

Returns or sets the ambient coefficient of a material. Ambient coefficient
value is between 0 to 1.
Return type:

float

property bump: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Bump() As double

Returns or sets the texture bump. Image texture bump value is between -10
to 10.
Return type:

float

property chessboard_joint_height: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ChessboardJointHeight() As double

Returns or sets the height of the join of a chessboard texture. Height
value is between 0 to 100. N.B. Parameter use for CHESSBOARD texture type only.
Return type:

float

property chessboard_joint_width: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ChessboardJointWidth() As double

Returns or sets the width of the join of a chessboard texture. Width value
is between 0 to 100. N.B. Parameter use for CHESSBOARD texture type only.
Return type:

float

property chessboard_offset: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ChessboardOffset() As double

Returns or sets the offset coefficient for a chessboard texture. It
indicates the offset between each line of the chessboard texture. Offset value
is between 0 to 0.5. N.B. Parameter use for CHESSBOARD texture type only.
Return type:

float

property chessboard_tile_height: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ChessboardTileHeight() As double

Returns or sets the height of the tile of a chessboard texture. Height
value is between 0 to 100. N.B. Parameter use for CHESSBOARD texture type only.
Return type:

float

property chessboard_tile_width: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ChessboardTileWidth() As double

Returns or sets the width of the tile of a chessboard texture. Width value
is between 0 to 100. N.B. Parameter use for CHESSBOARD texture type only.
Return type:

float

property color_number: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ColorNumber() As short

Returns or sets the 3d texture color number. Possible color numbers are: -
From 2 to 5 for marble, vein and chessboard texture types - From 1 to 5 for
alternate vein texture types N.B. Parameter useless for ROCK textures (color
number is fixed) and IMAGE texture
Return type:

int

property diffuse_coefficient: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property DiffuseCoefficient() As double

Returns or sets the diffuse coefficient of a material. Diffuse coefficient
value is between 0 to 1.
Return type:

float

property environment_image: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property EnvironmentImage() As CATBSTR

Returns or sets the environment image pathname of a material.
Return type:

str

property flip_u: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property FlipU() As boolean

Returns or sets the texture flip status along U axis. N.B. Parameter use
for IMAGE texture type only
Return type:

bool

property flip_v: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property FlipV() As boolean

Returns or sets the texture flip status along V axis. N.B. Parameter use
for IMAGE texture type only
Return type:

bool

get_3d_texture_color(i_color_index: int) → tuple[int, int, int]

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Get3DTextureColor(short iColorIndex,
CATSafeArrayVariant o3DTextureColor)

Returns one color of a 3d texture. The color to access is identified with
its index. The color is expressed with r, g, and b coefficients (between 0 and
255).

Parameters:

iColorIndex
The index of the color to access

Returns:
the color as a safe array made up of three doubles: r, g,
b
The r, g, b values ranges from 0 to 255.
The array must be previously initialized. N.B. Parameter useless for
image textures.
Parameters:

i_color_index (int) –

Return type:

tuple

get_3d_texture_color_coefficient(i_color_index: int) → tuple[int, int, int]

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Get3DTextureColorCoefficient(short iColorIndex,
double o3DTextureColorCoefficient)

Returns one color coefficient of a 3d texture. The color to access is
identified with its index.

Parameters:

iColorIndex
The index of the color to access.

Returns:
the color coefficient.
If the color is enable, the color coefficient value should range from 0
to 1.
If color is disable, the color coefficient is equal to
-1.
N.B. Parameter useless for rock, chessboard and image textures.
Parameters:

i_color_index (int) –

Return type:

tuple

get_3d_texture_orientation() → tuple[float, float, float]

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Get3DTextureOrientation(CATSafeArrayVariant
o3DTextureOrientation)

Returns the orientation of a texture. The orientation is expressed with 3
coefficients (orientation around X, Y and Z axis). The orientation values must
be between -360 and 360 degrees. N.B. Parameter useless for IMAGE textures (use
get_Orientation, set_Orientation methods for IMAGE type).

Returns:
the orientation as a safe array made up of three doubles: rotationX,
rotationY, rotationZ.
The array must be previously initialized.
Return type:

tuple

get_3d_texture_position() → tuple[float, float, float]

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Get3DTexturePosition(CATSafeArrayVariant
o3DTexturePosition)

Returns the position of a texture. The position is expressed with 3
coefficients (position along X, Y and Z axis). The position values must be
between -100 and 100. N.B. Parameter useless for IMAGE textures (use PositionU,
PositionV methods for IMAGE type).

Returns:
the position as a safe array made up of three doubles: positionX,
positionY, positionZ.
The array must be previously initialized.
Return type:

tuple

get_3d_texture_scale() → tuple[int, int, int]

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Get3DTextureScale(CATSafeArrayVariant o3DTextureScale)

Returns the scale of a texture. The scale is expressed with 3 coefficients
(scale along X, Y and Z axis) The scale values must be > 0 and ≤ 100. N.B.
Parameter useless for IMAGE textures. (use get_ScaleU, set_ScaleU, get_ScaleV,
set_ScaleV methods for IMAGE type)

Returns:
the scale as a safe array made up of three doubles: scaleX, scaleY,
scaleZ.
The array must be previously initialized.
Return type:

tuple

get_ambient_color() → tuple[int, int, int]

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetAmbientColor(CATSafeArrayVariant oAmbientColor)

Returns the ambient color of a material. The color is expressed with r, g,
and b coefficients (between 0 and 255)

Returns:
the color as a safe array made up of three doubles: r, g,
b
The r, g, b values ranges from 0 to 255.
The array must be previously initialized.
Return type:

tuple

get_diffuse_color() → tuple[int, int, int]

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetDiffuseColor(CATSafeArrayVariant oDiffuseColor)

Returns the diffuse color of a material. The color is expressed with r, g,
and b coefficients (between 0 and 255)

Returns:
the color as a safe array made up of three doubles: r, g,
b
The r, g, b values ranges from 0 to 255.
The array must be previously initialized.
Return type:

tuple

get_specular_color() → tuple[int, int, int]

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetSpecularColor(CATSafeArrayVariant oSpecularColor)

Returns the specular color of a material. The color is expressed with r, g,
and b coefficients (between 0 and 255)

Returns:
the color as a safe array made up of three doubles: r, g,
b
The r, g, b values ranges from 0 to 255.
The array must be previously initialized.
Return type:

tuple

get_transparency_color() → tuple[int, int, int]

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetTransparencyColor(CATSafeArrayVariant
oTransparencyColor)

Returns the transparent color of a material. The color is expressed with r,
g, and b coefficients (between 0 and 255)

Parameters:

oTransparencyColor
The color as a safe array made up of three doubles: r, g,
b
The r, g, b values ranges from 0 to 255.
The array must be previously initialized.
Return type:

tuple

property mapping_type: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property MappingType() As short

Returns or sets the mapping type of a material.

Possible types are:
0: Planar mapping
1: Spherical mapping
2: Cylindrical mapping
3: Cubical mapping
4: Auto mapping
5: Manual mapping
Return type:

int

property orientation: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Orientation() As double

Returns or sets the texture orientation. Orientation value should be
between -360 to +360 degrees N.B. Parameter use for IMAGE texture type only
Return type:

float

property position_u: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property PositionU() As double

Returns or sets the texture position along U axis. N.B. Parameter use for
IMAGE texture type only
Return type:

float

property position_v: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property PositionV() As double

Returns or sets the texture position along V axis. N.B. Parameter use for
IMAGE texture type only
Return type:

float

property preview_size: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property PreviewSize() As double

Returns or sets the preview size of a material. Preview size value is 0.1mm
minimum.
Return type:

float

put_3d_texture_color(i_color_index: int, i_3d_texture_color: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Put3DTextureColor(short iColorIndex,
CATSafeArrayVariant i3DTextureColor)

Sets one color of a 3d texture. The color to access is identified with its
index. The color is expressed with r, g, and b coefficients (between 0 and
255)

Parameters:

iColorIndex
The index of the color to access.
i3DTextureColor
The color as a safe array made up of three doubles: r, g,
b
The r, g, b values ranges from 0 to 255.
The array must be previously initialized. N.B. Parameter useless
for image textures.
Parameters:

  • i_color_index (int) –

  • i_3d_texture_color (tuple) –

Return type:

None

put_3d_texture_color_coefficient(i_color_index: int, i_3d_texture_color_coefficient: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Put3DTextureColorCoefficient(short iColorIndex,
double i3DTextureColorCoefficient)

Sets one color coefficient of a 3d texture. The color to access is
identified with its index.

Parameters:

iColorIndex
The index of the color to access.
i3DTextureColorCoefficient.
The color coefficient.
If color is enable, the color coefficient value should range from 0
to 1.
If color is disable, the color coefficient should be equal to
-1.
N.B. Parameter useless for rock, chessboard and image
textures.
Parameters:

  • i_color_index (int) –

  • i_3d_texture_color_coefficient (float) –

Return type:

None

put_3d_texture_orientation(i_3d_texture_orientation: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Put3DTextureOrientation(CATSafeArrayVariant
i3DTextureOrientation)

Sets the orientation of a texture. The orientation is expressed with 3
coefficients (orientation around X, Y and Z axis). The orientation values must
be between -360 and 360 degrees. N.B. Parameter useless for IMAGE textures (use
get_Orientation, set_Orientation methods for IMAGE type).

Parameters:

i3DTextureOrientation
The orientation as a safe array made up of three doubles:
rotationX, rotationY, rotationZ.
The array must be previously initialized.
Parameters:

i_3d_texture_orientation (tuple) –

Return type:

None

put_3d_texture_position(i_3d_texture_position: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Put3DTexturePosition(CATSafeArrayVariant
i3DTexturePosition)

Sets the position of a texture. The position is expressed with 3
coefficients (position along X, Y and Z axis). The position values must be
between -100 and 100. N.B. Parameter useless for IMAGE textures (use PositionU,
PositionV methods for IMAGE type).

Parameters:

i3DTexturePosition
The position as a safe array made up of three doubles: positionX,
positionY, positionZ.
The array must be previously initialized.
Parameters:

i_3d_texture_position (tuple) –

Return type:

None

put_3d_texture_scale(i_3d_texture_scale: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Put3DTextureScale(CATSafeArrayVariant i3DTextureScale)

Sets the scale of a texture. The scale is expressed with 3 coefficients
(scale along X, Y and Z axis). The scale values must be > 0 and ≤ 100. N.B.
Parameter useless for IMAGE textures (use get_ScaleU, set_ScaleU, get_ScaleV,
set_ScaleV methods for IMAGE type).

Parameters:

i3DTextureScale
The scale as a safe array made up of three doubles: scaleX, scaleY,
scaleZ.
The array must be previously initialized.
Parameters:

i_3d_texture_scale (tuple) –

Return type:

None

put_ambient_color(i_ambient_color: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub PutAmbientColor(CATSafeArrayVariant iAmbientColor)

Sets the ambient color of a material. The color is expressed with r, g, and
b coefficients (between 0 and 255)

Parameters:

oAmbientColor
The color as a safe array made up of three doubles: r, g,
b
The r, g, b values ranges from 0 to 255.
The array must be previously initialized.
Parameters:

i_ambient_color (tuple) –

Return type:

None

put_diffuse_color(i_diffuse_color: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub PutDiffuseColor(CATSafeArrayVariant iDiffuseColor)

Sets the diffuse color of a material. The color is expressed with r, g, and
b coefficients (between 0 and 255)

Parameters:

oDiffuseColor
The color as a safe array made up of three doubles: r, g,
b
The r, g, b values ranges from 0 to 255.
The array must be previously initialized.
Parameters:

i_diffuse_color (tuple) –

Return type:

None

put_specular_color(i_specular_color: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub PutSpecularColor(CATSafeArrayVariant iSpecularColor)

Sets the specular color of a material. The color is expressed with r, g,
and b coefficients (between 0 and 255)

Parameters:

oSpecularColor
The color as a safe array made up of three doubles: r, g,
b
The r, g, b values ranges from 0 to 255.
The array must be previously initialized.
Parameters:

i_specular_color (tuple) –

Return type:

None

put_transparency_color(i_transparency_color: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub PutTransparencyColor(CATSafeArrayVariant
iTransparencyColor)

Sets the transparent color of a material. The color is expressed with r, g,
and b coefficients (between 0 and 255)

Parameters:

iTransparencyColor
The color as a safe array made up of three doubles: r, g,
b
The r, g, b values ranges from 0 to 255.
The array must be previously initialized.
Parameters:

i_transparency_color (tuple) –

Return type:

None

property reflection_height: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ReflectionHeight() As double

Returns or sets the non-linear reflection height of a material. Non-linear
reflection height value is between 0 to 1. N.B. Parameter use for CUSTOM
reflection mode only.
Return type:

float

property reflection_length: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ReflectionLength() As double

Returns or sets the non-linear reflection length of a material. Non-linear
reflection length value is between 0 to 1. N.B. Parameter use for CUSTOM
reflection mode only.
Return type:

float

property reflection_mode: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ReflectionMode() As short

Returns or sets the non-linear reflection mode of a
material.

Possible reflection mode values are:
0: CHROMA reflection mode
1: PAINT reflection mode
2: MATTE_METAL reflection mode
3: BRIGHT_PLASTIC reflection mode
4: CUSTOM reflection mode
Return type:

int

property reflectivity_coefficient: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ReflectivityCoefficient() As double

Returns or sets the reflectivity coefficient of a material. Reflectivity
coefficient value is between 0 to 1.
Return type:

float

property refraction_coefficient: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property RefractionCoefficient() As double

Returns or sets the refraction coefficient of a material. Refraction
coefficient value is between 1 to 2.
Return type:

float

property repeat_u: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property RepeatU() As boolean

Returns or sets the texture repeat status along U axis. N.B. Parameter use
for IMAGE texture type only
Return type:

bool

property repeat_v: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property RepeatV() As boolean

Returns or sets the texture repeat status along V axis. N.B. Parameter use
for IMAGE texture type only
Return type:

bool

property scale_u: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ScaleU() As double

Returns or sets the texture scale along U axis. U scale value is between 0
to 100. N.B. Parameter use for IMAGE texture type only
Return type:

float

property scale_v: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ScaleV() As double

Returns or sets the texture scale along V axis. V scale value is between 0
to 100. N.B. Parameter use for IMAGE texture type only
Return type:

float

property specular_coefficient: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property SpecularCoefficient() As double

Returns or sets the specular coefficient of a material. Specular
coefficient value is between 0 to 1.
Return type:

float

property specular_exponent: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property SpecularExponent() As double

Returns or sets the specular exponent of a material. Specular exponent
value is between 0 to 1.
Return type:

float

property texture_amplitude: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property TextureAmplitude() As double

Returns or sets the 3d texture amplitude coefficient. Amplitude value is
between 0 to 1. N.B. Parameter use for MARBLE and ROCK texture type only.
Return type:

float

property texture_complexity: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property TextureComplexity() As short

Returns or sets the 3d texture complexity. Complexity value is between 0 to
10. N.B. Parameter use for MARBLE and ROCK texture types only.
Return type:

int

property texture_gain: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property TextureGain() As double

Returns or sets the 3d texture gain coefficient. Gain value is between 0 to
2. N.B. Parameter use for ROCK texture type only.
Return type:

float

property texture_image: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property TextureImage() As CATBSTR

Returns or sets the texture image pathname of a material. N.B. Parameter
use for IMAGE texture type only
Return type:

str

property texture_perturbation: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property TexturePerturbation() As double

Returns or sets the 3d texture perturbation coefficient. Perturbation value
is between 1 to 10. N.B. Parameter use for VEIN, ALTERNATE VEIN and ROCK
texture types only.
Return type:

float

property texture_turbulence: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property TextureTurbulence() As boolean

Returns or sets the 3d texture turbulence status. N.B. Parameter use for
ROCK texture type only.
Return type:

bool

property texture_type: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property TextureType() As short

Returns or sets the texture type of a material. The possible values for
this type can be:

Possible reflection mode values are:
0: NO texture
1: IMAGE texture
2: MARBLE texture
3: VEIN texture
4: ALTERNATE VEIN texture
5: ROCK texture
6: CHESSBOARD texture
Return type:

int

property texture_vein_amplitude: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property TextureVeinAmplitude() As double

Returns or sets the 3d texture vein amplitude coefficient. Amplitude value
is between 0 to 10. N.B. Parameter use for VEIN and ALTERNATE VEIN texture
types only.
Return type:

float

property transparency_coefficient: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property TransparencyCoefficient() As double

Returns or sets the transparency coefficient of a material. Transparency
coefficient value is between 0 to 1.
Return type:

float