pycatia.cat_rsc_interfaces.rendering_light

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_light.RenderingLight(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
RenderingLight

Represents a Rendering Light 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 light active status.
A light illuminates only when it is active. The active status can
be:
1: light is on
0: light is off
Returns

int

Return type

int

property ambient: float

Note

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

Returns or sets the light ambient intensity of a light.
Returns

float

Return type

float

property angle: float

Note

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

Returns or sets the light angle of a spot light.
The angle ranges from 0. (directional light) to 360. (point light).
Returns

float

Return type

float

property area_samples_u: int

Note

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

Changes the number of samples taken in U direction of the area source.
Returns

int

Return type

int

property area_samples_v: int

Note

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

Changes the number of samples taken in V direction of the area source.
Returns

int

Return type

int

property area_status: int

Note

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

Returns or sets the light area visibility status.
The area visibility status can be:
1: light area is rendered
0: light area is not rendered
Returns

int

Return type

int

property attenuation_angle_ratio: float

Note

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

Returns or sets the light attenuation angle ratio.
It represents the fraction of the light angle where the illumination starts
to attenuate.
The ratio ranges from 0. (attenuation starts when angle is null) to 1.
(attenuation starts when angle is maximum = no angle attenuation).
Returns

float

Return type

float

property attenuation_start_ratio: float

Note

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

Returns or sets the light attenuation start ratio.
It represents the fraction of the end distance where the light intensity
starts to attenuate.
The ratio ranges from 0. (attenuation starts at the origin) to 1.
(attenuation starts at the end distance = no attenuation).
Returns

float

Return type

float

property caustic_photons_number: int

Note

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

Changes the maximum number of caustic photons to emit from the light
source.
Returns

int

Return type

int

property cylinder_light_height: float

Note

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

Returns or sets the cylinder light area radius.
Returns

float

Return type

float

property cylinder_light_radius: float

Note

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

Returns or sets the cylinder light area radius.
Returns

float

Return type

float

property diffuse: float

Note

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

Returns or sets the light diffuse intensity of a light.
Returns

float

Return type

float

property disk_light_radius: float

Note

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

Returns or sets the disk light area radius.
Returns

float

Return type

float

property end_distance: float

Note

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

Returns or sets the light maximum distance of
illumination.
The light illuminates from its origin to its end distance. Objects farther
than this distance are not affected by the light.
Returns

float

Return type

float

property energy_factor: float

Note

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

Changes the factor for indirect illumination energy.
Returns

float

Return type

float

property falloff_exponent: int

Note

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

Changes the light falloff exponent. Exponent value can be 0, 1 or
2.
An exponent of 0 means that the light energy does not fall off with distance.
An exponent of 1 means that the light energy fall off is linear.
An exponent of 2 is physically correct.
Returns

int

Return type

int

get_colour(o_colour: tuple) → None

Note

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

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

Parameters:

oColor
The color as a safe array made up of three doubles: r, g,
b
The array must be previously initialized.
Parameters

o_colour (tuple) –

Returns

None

Return type

None

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 light.
These coordinates are set as an array of 3 Variants (double type).
Parameters

o_origin (tuple) –

Returns

None

Return type

None

get_shadow_colour(o_shadow_colour: tuple) → None

Note

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

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

Parameters:

oColor
The color as a safe array made up of three doubles: r, g,
b
The array must be previously initialized.
Parameters

o_shadow_color (tuple) –

Returns

None

Return type

None

get_target(o_target: tuple) → None

Note

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

Returns the coordinates of the target point of the light.
These coordinates are set as an array of 3 Variants (double type).
Parameters

o_target (tuple) –

Returns

None

Return type

None

property global_photons_number: int

Note

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

Changes the maximum number of global illumination photons to emit from the
light source.
Returns

int

Return type

int

property hardware_shadow_smoothing: int

Note

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

Returns or sets the light shadow smoothing.
It is an integer in the scale 0 to 10 It represents the cleanliness of the
shadow limits
Returns

int

Return type

int

property hardware_shadow_status: int

Note

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

Returns or sets the light shadow status on environment.
The shadow status can be:
1: light casts shadows on environment
0: light does not cast shadows on environment

The shadow status on environmemt can be activate only with a directional
light
Returns

int

Return type

int

property hardware_shadow_transparency: float

Note

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

Returns or sets the light shadow transparency.
It is a float in the scale 0.0(no transparency) to 1.0 (full transparency)
Returns

float

Return type

float

property illumination_status: int

Note

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

Changes the indirect illumination status.
The indirect illumination status can be:
1: indirect illumination is enabled
0: indirect illumination is disabled
Returns

int

Return type

int

property intensity: float

Note

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

Returns or sets the light intensity of a light.
Returns

float

Return type

float

property light_area_type: int

Note

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

Returns or sets the light area type.

Possible area light types are:
1: CATNone
2: CATRectangle
3: CATDisk
4: CATSphere
5: CATCylinder
Returns

int

Return type

int

property mode: int

Note

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

Returns or sets the light mode.

Possible light modes are:
1: Light is linked to the viewpoint
2: Light is linked to the model
Returns

int

Return type

int

put_colour(i_colour: tuple) → None

Note

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

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

i_colour (tuple) –

Returns

None

Return type

None

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 light.
These coordinates are set as an array of 3 Variants (double
type).

Example:
This example sets the origin of the MyLight light. to the point with
coordinates (10, 25, 15).

MyLight.PutOrigin Array(10, 25, 15)
Parameters

i_origin (tuple) –

Returns

None

Return type

None

put_shadow_colour(i_shadow_colour: tuple) → None

Note

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

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

i_shadow_color (tuple) –

Returns

None

Return type

None

put_target(i_target: tuple) → None

Note

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

Sets the coordinates of the target point of the light.
These coordinates are set as an array of 3 Variants (double type).
Parameters

i_target (tuple) –

Returns

None

Return type

None

property rectangle_light_length: float

Note

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

Returns or sets the light area length.
Returns

float

Return type

float

property rectangle_light_width: float

Note

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

Returns or sets the light area width.
Returns

float

Return type

float

property shadow_fitting_mode: int

Note

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

Returns or sets the light shadow fitting mode.
The shadow fitting mode can be:
0: Standard
1: Good
Returns

int

Return type

int

property shadow_map_size: int

Note

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

Returns or sets the light shadow map size.
The shadow map size can be:
0: Small (512)
1: Medium (1024)
2: Large (2048)
Returns

int

Return type

int

property shadow_object_status: int

Note

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

Returns or sets the light shadow status on objet.
The shadow status can be:
1: light casts shadows on objet
0: light does not cast shadows on objet

The shadow status on object can be activate only with a spot light
Returns

int

Return type

int

property shadow_status: int

Note

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

Returns or sets the light shadow status.
The shadow status can be:
1: light casts shadows
0: light does not cast shadows
Returns

int

Return type

int

property specular: float

Note

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

Returns or sets the light specular intensity of a light.
Returns

float

Return type

float

property sphere_light_radius: float

Note

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

Returns or sets the sphere light area radius.
Returns

float

Return type

float

property type: int

Note

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

Returns or sets the light type.

Possible light types are:
1: Spot light
2: Point light
3: Directional light
Returns

int

Return type

int