File: imagedef.rst

package info (click to toggle)
ezdxf 1.4.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 104,528 kB
  • sloc: python: 182,341; makefile: 116; lisp: 20; ansic: 4
file content (65 lines) | stat: -rw-r--r-- 1,594 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
ImageDef
========

.. module:: ezdxf.entities
    :noindex:

The `IMAGEDEF`_ entity defines an image file, which can be placed by the :class:`Image`
entity.

======================== ===========================================================
Subclass of              :class:`ezdxf.entities.DXFObject`
DXF type                 ``'IMAGEDEF'``
Factory function (1)     :meth:`ezdxf.document.Drawing.add_image_def`
Factory function (2)     :meth:`ezdxf.sections.objects.ObjectsSection.add_image_def`
======================== ===========================================================

.. warning::

    Do not instantiate object classes by yourself - always use the provided factory functions!

.. _IMAGEDEF: http://help.autodesk.com/view/OARX/2018/ENU/?guid=GUID-EFE5319F-A71A-4612-9431-42B6C7C3941F


.. class:: ImageDef

    .. attribute:: dxf.class_version

        Current version is 0.

    .. attribute:: dxf.filename

        Relative (to the DXF file) or absolute path to the image file as string.

    .. attribute:: dxf.image_size

        Image size in pixel as (x, y) tuple.

    .. attribute:: dxf.pixel_size

        Default size of one pixel in drawing units as (x, y) tuple.

    .. attribute:: dxf.loaded

        0 = unloaded; 1 = loaded, default is 1

    .. attribute:: dxf.resolution_units

        === ==================
        0   No units
        2   Centimeters
        5   Inch
        === ==================

        default is 0


ImageDefReactor
===============


.. class:: ImageDefReactor

    .. attribute:: dxf.class_version

    .. attribute:: dxf.image_handle