pycatia.in_interfaces.light_source

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-07-06 14:02:20.222384

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.in_interfaces.light_source.LightSource(com_object)

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

LightSource

Represents the light source.

The light source is the object that stores lighting data used by a viewer to

display a scene where a document is presented. Two kinds of light sources are

available: an infinite light source and a neon lighting system simulating a set

of parallel neon tubes.

get_direction(o_direction: tuple) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetDirection(CATSafeArrayVariant oDirection)

Returns the lighting direction as an array of 3 variants. This value is

available with an infinite light source only.

Example:

This example gets the lighting direction of the LightSource light

source to the direction with components (5,8,-2).

Dim direction(2)

LightSource.GetDirection direction

Parameters:

o_direction (tuple) –

Return type:

None

put_direction(o_direction: tuple) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub PutDirection(CATSafeArrayVariant oDirection)

Defines the lighting direction as an array of 3 variants. This value can be

set with an infinite light source only.

Example:

This example defines the lighting direction of the LightSource light

source to the direction with components (5,8,-2).

LightSource.PutDirection Array(5,8,-2)

Parameters:

o_direction (tuple) –

Return type:

None