pycatia.drafting_interfaces.drawing_picture

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.drafting_interfaces.drawing_picture.DrawingPicture(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
DrawingPicture

Represents a drawing picture in a drawing view.
property crop_bottom: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property cropBottom() As double

Returns or sets the cropBottom of the drawing picture. The cropBottom is
the size of the margin on the bottom of the picture. The cropBottom, like any
length, is measured in millimeters.

Example:
This example sets the cropBottom of the MyPicture drawing picture to 10
mm

MyPicture.cropBottom = 10.
Return type:

float

property crop_left: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property cropLeft() As double

Returns or sets the cropLeft of the drawing picture. The cropLeft is the
size of the margin on the left of the picture. The cropLeft, like any length,
is measured in millimeters.

Example:
This example sets the cropLeft of the MyPicture drawing picture to 10
mm

MyPicture.cropLeft = 10.
Return type:

float

property crop_right: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property cropRight() As double

Returns or sets the cropRight of the drawing picture. The cropRight is the
size of the margin on the right of the picture. The cropRight, like any length,
is measured in millimeters.

Example:
This example sets the cropRight of the MyPicture drawing picture to 10
mm

MyPicture.cropRight = 10.
Return type:

float

property crop_top: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property cropTop() As double

Returns or sets the cropTop of the drawing picture. The cropTop is the size
of the margin on the top of the picture. The cropTop, like any length, is
measured in millimeters.

Example:
This example sets the cropTop of the MyPicture drawing picture to 10
mm

MyPicture.cropTop = 10.
Return type:

float

property format: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property format() As CatPictureFormat

Sets the picture format.

Parameters:

iPictureFormat
Compression format.

Returns:

Legal values:

S_OK
Method correctly executed.
E_FAIL
Method execution failed.
Reasons of the failure are not given.
E_IMPL
No implementation available for this method.

See also:
CatPictureFormat
Returns:

enum cat_picture_format

Return type:

int

get_original_height() → float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetOriginalHeight() As double

Gets the original height of the drawing picture. The height, like any
length, is measured in millimeters.

Example:
This example gets the original height of the MyPicture drawing
picture

Height = MyPicture.GetOriginalHeight()
Return type:

float

get_original_width() → float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetOriginalWidth() As double

Gets the original width of the drawing picture. The width, like any length,
is measured in millimeters.

Example:
This example gets the original width of the MyPicture drawing
picture

Width = MyPicture.GetOriginalWidth()
Return type:

float

property height: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property height() As double

Returns or sets the height of the drawing picture. The height, like any
length, is measured in millimeters.

Example:
This example gets the height of the MyPicture drawing
picture

Height = MyPicture.height
Return type:

float

property ratio_lock: bool

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property ratioLock() As boolean

Returns or sets the ratioLock of the drawing picture. The ratioLock is a
boolean value If ratioLock is True it means that the size must not be changed
by command in a interactive session.But it does not avoid size modifications
thru VBScript exec (height and width still available for
modification).

Example:
This example sets the ratioLock of the MyPicture drawing picture to
True

MyPicture.ratioLock = True
Return type:

bool

property width: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property width() As double

Returns or sets the width of the drawing picture. The width, like any
length, is measured in millimeters.

Example:
This example gets the width of the MyPicture drawing
picture

Width = MyPicture.width
Return type:

float

property x: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property x() As double

Returns or sets the x coordinate of the drawing picture position. It is
expressed with respect to the view coordinate system. This coordinate, like any
length, is measured in millimeters.

Example:
This example sets the x coordinate of the position of the MyPicture
drawing picture to 5 inches. You need first to convert the 5 inches into
millimeters.

NewXCoordinate = 5*25.4
MyPicture.x = NewXCoordinate
Return type:

float

property y: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property y() As double

Returns or sets the y coordinate of the drawing picture position. It is
expressed with respect to the view coordinate system. This coordinate, like any
length, is measured in millimeters.

Example:
This example sets the y coordinate of the position of the MyPicture
drawing picture to 5 inches. You need first to convert the 5 inches into
millimeters.

NewYCoordinate = 5*25.4
MyPicture.y = NewYCoordinate
Return type:

float