pycatia.cat_rsc_interfaces.rendering_shooting

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_shooting.RenderingShooting(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

RenderingShooting

Represents a Material object.

property active_camera: Camera3D

Note

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

o Property ActiveCamera() As Camera3D

Returns or sets the active camera for shooting. A shooting can only have

one active camera at a time.

Return type:

Camera3D

property active_environment: RenderingEnvironment

Note

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

o Property ActiveEnvironment() As RenderingEnvironment

Returns or sets the active environment for shooting.

A shooting can have one or zero active environment at a time.

Return type:

RenderingEnvironment

add_active_light(i_active_light: RenderingLight) → None

Note

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

o Sub AddActiveLight(RenderingLight iActiveLight)

Adds a new active light to the shooting active lights list.

Parameters:

i_active_light (RenderingLight) –

Return type:

None

property ambient_factor: int

Note

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

o Property AmbientFactor() As short

Returns or sets amount of ambient used for indirect illumination (final

gathering or global illumination).

The ambient factor can be:

1: Ambient is taken into account

0: No ambient used

Return type:

int

property antialiasing_contrast: int

Note

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

o Property AntialiasingContrast() As short

Returns or sets the antialiasing contrast threshold value.

This value ranges from 0. to 100.%. Contrast value sets the contrast

threshold for adaptative oversampling, that is, the maximum contrast threshold

between pixels, below which no oversampling will be done.

If the contrast of any RGB component between the currently calculated pixel

and heighboring pixels weighted by their sum is greater than this threshold,

the pixel is oversampled.

Return type:

int

property antialiasing_max_sample: int

Note

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

o Property AntialiasingMaxSample() As short

Returns or sets the antialiasing maximum sample number for image

computation.

This value ranges from 0/code> to 5/code>.

Maximum samples value sets the minimum number of rays casted for 1,4 or 16

pixels.

The possible maximum sample number are:

0 : 1 ray casted for a 4x4 pixel square

1 : 1 ray casted for a 2x2 pixel square

2 : 1 ray casted per pixel

3 : 4 rays casted per pixel

4 : 16 rays casted per pixel

5 : 64 rays casted per pixel

Return type:

int

property antialiasing_min_sample: int

Note

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

o Property AntialiasingMinSample() As short

Returns or sets the antialiasing minimum sample number for image

computation.

This value ranges from 0/code> to 5/code>.

Minimum samples value sets the minimum number of rays casted for 1,4 or 16

pixels.

The possible minimum sample number are:

0 : 1 ray casted for a 4x4 pixel square

1 : 1 ray casted for a 2x2 pixel square

2 : 1 ray casted per pixel

3 : 4 rays casted per pixel

4 : 16 rays casted per pixel

5 : 64 rays casted per pixel

Return type:

int

property cartoon_contour_thickness: float

Note

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

o Property CartoonContourThickness() As double

Returns or sets the cartoon contour thickness.

The line thickness is given as image size percentage.

The line thickness ranges from 0.0 (none) to 100.0.

Return type:

float

property cartoon_shading_status: int

Note

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

o Property CartoonShadingStatus() As short

Returns or sets the cartoon shading status of shooting.

This status defines if the cartoon shading is activated or

not.

If shading is deactivated, only contours are rendered.

The cartoon shading effect status can be:

1: Shading status is active

0: Shading status is deactivated

Return type:

int

property cartoon_status: int

Note

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

o Property CartoonStatus() As short

Returns or sets the cartoon status of shooting.

This status defines if the cartoon rendering is activated or

not.

The cartoon effect status can be:

1: Cartoon status is active

0: Cartoon status is deactivated

Return type:

int

property cartoon_stroke_status: int

Note

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

o Property CartoonStrokeStatus() As short

Returns or sets the cartoon stroke status of shooting.

This status defines if the cartoon stroke effect (ink pen effect) is

activated or not.

The stroke status can be:

1: Stroke status is active

0: Stroke status is deactivated

Return type:

int

property caustic_accuracy: int

Note

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

o Property CausticAccuracy() As short

Returns or sets the number of photons to use when estimating radiance for

caustics.

Return type:

int

property caustic_radius: float

Note

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

o Property CausticRadius() As double

Returns or sets the maximum distance in which photons for caustics are

located.

If the value is 0.0 an estimate based on the scene extent will be used.

Return type:

float

property caustic_status: int

Note

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

o Property CausticStatus() As short

Returns or sets the caustic status of shooting.

This status defines if caustics are calculated or not.

The caustic status can be:

1: Caustics are enabled

0: Caustics are disabled

Return type:

int

count_active_lights() → int

Note

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

o Func CountActiveLights() As short

Returns the number of active light for the shooting.

Return type:

int

property depth_of_field_radius: float

Note

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

o Property DepthOfFieldRadius() As double

Returns or sets the depth of field radius of confusion.

The radius of confusion ranges from 1.0 to 10.0%.

Return type:

float

property depth_of_field_status: int

Note

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

o Property DepthOfFieldStatus() As short

Returns or sets the depth of field status of shooting. This status defines

if depth of field effect is activated or not.

The depth of field status can be:

1: Depth of field is active

0: Depth of field is deactivated

Return type:

int

property final_gathering_accuracy: int

Note

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

o Property FinalGatheringAccuracy() As short

Returns or sets the number of rays shot in each final gather.

Return type:

int

property final_gathering_max_radius: float

Note

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

o Property FinalGatheringMaxRadius() As double

Returns or sets the maximum distance in which a final gather result can be

used.

If the value is 0.0 an estimate based on the scene extent will be used.

Return type:

float

property final_gathering_min_radius: float

Note

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

o Property FinalGatheringMinRadius() As double

Returns or sets the minimum distance in which a final gather result can be

used.

If the value is 0.0 it will be set to 10% of maximum distance.

Return type:

float

property final_gathering_status: int

Note

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

o Property FinalGatheringStatus() As short

Returns or sets the final gathering status of shooting.

This status defines if final gathering is activated or

not.

The final gathering status can be:

1: Final gathering is enabled

0: Final gathering is disabled

Return type:

int

get_active_light(i_index: int) → RenderingLight

Note

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

o Func GetActiveLight(short iIndex) As RenderingLight

Returns the active light of the shooting using its index.

Parameters:

i_index (int) –

Return type:

RenderingLight

property global_illumination_accuracy: int

Note

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

o Property GlobalIlluminationAccuracy() As short

Returns or sets the number of photons to use when estimating radiance for

global illumination.

Return type:

int

property global_illumination_radius: float

Note

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

o Property GlobalIlluminationRadius() As double

Returns or sets the maximum distance in which photons for global

illumination are located.

If the value is 0.0 an estimate based on the scene extent will be used.

Return type:

float

property global_illumination_status: int

Note

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

o Property GlobalIlluminationStatus() As short

Returns or sets the global illumination status of

shooting.

This status defines if global illumination is used or not.

The global illumination status can be:

1: Global illumination is enabled

0: Global illumination is disabled

Return type:

int

property glow_flare_diffusion: float

Note

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

o Property GlowFlareDiffusion() As double

Returns or sets the glow flare diffusion.

The flare diffusion value ranges from 0.0 to 1.0%.

Return type:

float

property glow_flare_factor: float

Note

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

o Property GlowFlareFactor() As double

Returns or sets the glow flare factor.

The flare factor ranges from 0.0 to 1.0%.

Return type:

float

property glow_intensity: float

Note

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

o Property GlowIntensity() As double

Returns or sets the glow intensity factor.

The glow intensity factor ranges from 1.0 to 10.0%.

Return type:

float

property glow_radial_line_size: float

Note

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

o Property GlowRadialLineSize() As double

Returns or sets the glow radial lines size.

The lines size ranges from 0.0 (none) to 1.0 (max length).

Return type:

float

property glow_size: float

Note

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

o Property GlowSize() As double

Returns or sets the glow filter size in percentage of image

size.

The filter size ranges from 0.1 to 1.0%.

Return type:

float

property glow_star_effect: float

Note

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

o Property GlowStarEffect() As double

Returns or sets the glow star effect.

The effect coefficient ranges from 0.0 (random star) to 1.0 (cross).

Return type:

float

property glow_status: int

Note

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

o Property GlowStatus() As short

Returns or sets the glow status of shooting. This status defines if the

glow effect is activated or not.

The glow status can be:

1: Glow is active

0: Glow is deactivated

Return type:

int

property glow_threshold: float

Note

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

o Property GlowThreshold() As double

Returns or sets the glow color threshold.

The color threshold ranges from 0.5 to 1.5%.

Return type:

float

property image_height: int

Note

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

o Property ImageHeight() As short

Returns or sets the image height for shooting.

The image height ranges from 10 to 8000 pixels.

Return type:

int

property image_output_directory: str

Note

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

o Property ImageOutputDirectory() As CATBSTR

Returns or sets the output directory for image.

This is the place where rendered images are saved.

Return type:

str

property image_output_format: int

Note

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

o Property ImageOutputFormat() As short

Returns or sets the file type used for saved image.

Possible format types

1 TIFF True Color (*.tif)

2 TIFF True Color Packbits (*.tif)

3 SGI Format (*.rgb)

4 Windows Bitmap (*.bmp)

5 JPEG Fair Quality (*.jpg)

6 JPEG Medium Quality (*.jpg)

7 JPEG High Quality (*.jpg)

8 Apple Macintosh Format (*.pic)

9 Adobe Photoshop Format (*.psd)

10 Portable Network Graphics (*.png)

11 Truevision Targa (*.tga)

Return type:

int

property image_output_name: str

Note

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

o Property ImageOutputName() As CATBSTR

Returns or sets the output name for image (extension

excluded).

This is the name of saved files (with no extension).

Return type:

str

property image_output_type: int

Note

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

o Property ImageOutputType() As short

Returns or sets the image output location.

Output types

1 On screen

2 On disk

Return type:

int

property image_predefined_ratio: int

Note

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

o Property ImagePredefinedRatio() As short

Returns or sets the image height for shooting.

Sets the image ratio to a standard predefined value. The image size keeps

the same height and the image length is recalculated.

Possible predefined ratio. 0 no predefined ratio

1 0.708333 (A4)

2 1.0 (6 x 6)

3 1.25 (Standard)

4 1.333333 (4 / 3)

5 1.5 (24 x 36)

6 1.687331 (16 mm.)

7 1.777777 (16 / 9)

8 1.855072 (HDTV)

9 2.2 (Panavision)

10 3.0 (Panorama)

11 1.32 (CCD 1/2”)

12 1.333333 (CCD 1/4”)

Return type:

int

property image_width: int

Note

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

o Property ImageWidth() As short

Returns or sets the image width for shooting.

The image width ranges from 10 to 8000 pixels.

Return type:

int

property raytracing_status: int

Note

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

o Property RaytracingStatus() As short

Returns or sets the the raytracing status for shooting.

The raytracing status can be:

1: Raytracing is active

0: Raytracing is deactivated

Return type:

int

property rebounds_count: int

Note

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

o Property ReboundsCount() As short

Returns or sets the maximum number of rebounds levels to take into account

for image computation.

This number ranges from 0 to 18 levels.

Return type:

int

property reflections_count: int

Note

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

o Property ReflectionsCount() As short

Returns or sets the maximum number of reflections levels to take into

account for image computation.

This number ranges from 0 to 9 levels.

Return type:

int

property refractions_count: int

Note

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

o Property RefractionsCount() As short

Returns or sets the maximum number of refractions levels to take into

account for image computation.

This number ranges from 0 to 9 levels.

Return type:

int

remove_active_light(i_index: int) → None

Note

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

o Sub RemoveActiveLight(short iIndex)

Removes a light from the shootings active lights list.

Parameters:

i_index (int) –

Return type:

None

render() → None

Note

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

o Sub Render()

Render the shooting

Caution: Product involved in rendering calculation should not be closed

before the end of computation. If product is closed, calculation is

interrupted.

Return type:

None

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 shadows status of shooting. This status defines if

shadows are calculated or not.

The shadows status can be:

1: Shadows on

0: Shadows off

Return type:

int

property textures_status: int

Note

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

o Property TexturesStatus() As short

Returns or sets the textures status of shooting. This status defines if

textures are taken into account for image computation.

The texture status can be:

1: Textures are taking into account

0: Textures are ignored

Return type:

int