pycatia.cat_rsc_interfaces.rendering_environment_wall

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_rsc_interfaces.rendering_environment_wall.RenderingEnvironmentWall(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

RenderingEnvironmentWall

Represents a Environment object.

property active_status: int

Note

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

o Property ActiveStatus() As short

Returns or sets the environment wall active status. A wall is visible only

when it is active.

The active status can be:

1: wall is visible

0: wall is invisible

Return type:

int

property auto_scale_status: int

Note

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

o Property AutoScaleStatus() As short

Returns or sets the texture automatic scaling status. If status is

automatic scaling, the texture fit is locked when the environment size is

modified.

The scaling status can be:

1: automatic scaling is on

0: automatic scaling is off

Return type:

int

fit_all_in_wall() → None

Note

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

o Sub FitAllInWall()

If a texture is mapped on the wall, scale automatically the texture to fit

inside the wall.

Return type:

None

property flip_u_status: int

Note

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

o Property FlipUStatus() As short

Returns or sets texture orientation status along the U

axis.

The flip status can be:

1: texture is flipped along the U axis

0: texture is not flipped along the U axis

Return type:

int

property flip_v_status: int

Note

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

o Property FlipVStatus() As short

Returns or sets texture orientation status along the V

axis.

The flip status can be:

1: texture is flipped along the V axis

0: texture is not flipped along the V axis

Return type:

int

property linked_scale_status: int

Note

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

o Property LinkedScaleStatus() As short

Returns or sets the texture scaling link status. If scales are linked,

modifying one scale will update the other keeping the ratio between U and V

constant.

The link status can be:

1: U and V scales are linked

0: U and V scales are not linked

Return type:

int

property rotation: float

Note

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

o Property Rotation() As double

Returns or sets the texture rotation angle (in degrees). The rotation

values must be between -360 and 360 degrees.

Return type:

float

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 the U axis. The scale value should

be > 0. Note that the modification of this parameter is useless if automatic

scaling is enabled.

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 the V axis. The scale value should

be > 0. Note that the modification of this parameter is useless if automatic

scaling is enabled.

Return type:

float

property shadows_status: int

Note

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

o Property ShadowsStatus() As short

Returns or sets the wall shadow status. A wall may or may not be affected

by lights depending on this status.

The shadows status can be:

1: wall is affected by active lights and can bear

shadows

0: wall is not affected by active lights and is always

seen

Return type:

int

property texture: str

Note

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

o Property Texture() As CATBSTR

Returns or sets the wall texture name. To remove the texture, use an empty

string.

Return type:

str

property translation_u: float

Note

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

o Property TranslationU() As double

Returns or sets the texture offset along the U axis. Note that this

parameter is useless if automatic scaling is enabled.

Return type:

float

property translation_v: float

Note

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

o Property TranslationV() As double

Returns or sets the texture offset along the V axis. Note that this

parameter is useless if automatic scaling is enabled.

Return type:

float