pycatia.cat_rsc_interfaces.rendering_environment

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.RenderingEnvironment(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

RenderingEnvironment

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 active status.

Only one environment can be active for a product. The active status can

be:

1: environment is activated

0: environment is deactivated

Return type:

int

property face_number: int

Note

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

o Property FaceNumber() As short

Returns or sets the spherical environment face number.

The default value for a new spherical environment is 2.

If face number is set to 1, a mapped texture image will covered whole

environment sphere.

If face number is set to 2, two different texture images can be mapped for

upper hemisphere and lower hemisphere.

N.B. This property is useless for cubical and cylindrical environments.

Return type:

int

get_origin(o_origin: tuple) → None

Note

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

o Sub GetOrigin(CATSafeArrayVariant oOrigin)

Returns the coordinates of the origin of the environment.

These coordinates are set as an array of 3 Variants (double type).

Parameters:

o_origin (tuple) –

Return type:

None

get_type() → int

Note

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

o Func GetType() As short

Returns the environment type.

Possible environment types are:

1: Cubical environment

2: Spherical environment

3: Cylindrical environment

Return type:

int

get_vertical_axis(o_axis: tuple) → None

Note

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

o Sub GetVerticalAxis(CATSafeArrayVariant oAxis)

Returns the coordinates of the vertical axis vector of the

environment.

These coordinates are set as an array of 3 Variants (double type).

Parameters:

o_axis (tuple) –

Return type:

None

get_wall(i_type: int) → RenderingEnvironmentWall

Note

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

o Func GetWall(short iType) As RenderingEnvironmentWall

Returns the environment walls.

The environment wall type can be:

1: North wall (for cubical and cylindrical environments)

2: South wall (for cubical and cylindrical environments)

3: East wall (for cubical environments)

4: West wall (for cubical environments)

5: Top wall (for cubical, cylindrical and shperical

environments)

6: Bottom wall (for cubical, cylindrical and shperical

environments)

Parameters:

i_type (int) –

Return type:

RenderingEnvironmentWall

property height: float

Note

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

o Property Height() As double

Returns or sets the cubic or cylindrical environment height value.

Return type:

float

property length: float

Note

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

o Property Length() As double

Returns or sets the cubic environment length value.

Return type:

float

put_origin(i_origin: tuple) → None

Note

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

o Sub PutOrigin(CATSafeArrayVariant iOrigin)

Sets the coordinates of the origin of the environment.

These coordinates are set as an array of 3 Variants (double

type).

Example:

This example sets the origin of the MyEnvironment environment. to the

point with coordinates (10, 25, 15).

MyEnvironment.PutOrigin Array(10, 25, 15)

Parameters:

i_origin (tuple) –

Return type:

None

put_vertical_axis(i_axis: tuple) → None

Note

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

o Sub PutVerticalAxis(CATSafeArrayVariant iAxis)

Sets the coordinates of the vertical axis vector of the

environment.

These coordinates are set as an array of 3 Variants (double type).

Parameters:

i_axis (tuple) –

Return type:

None

property radius: float

Note

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

o Property Radius() As double

Returns or sets the spherical or cylindrical environment radius value.

Return type:

float

property width: float

Note

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

o Property Width() As double

Returns or sets the cubic environment width value.

Return type:

float