h~"ddlmZddlmZmZmZmZmZddlZddl m Z m Z ddl m Z ddlmZddlmZdd lmZerdd lmZdd lmZdd lmZmZmZmZmZej<d ZddZ GddeZ!Gdde!Z"Gdde!Z#ddZ$y)) annotations) TYPE_CHECKINGAnyUnioncastOptionalN)Vec2UVec) EntitySpace)const)make_table_key) BaseLayout)Drawing) BlockLayout)GeoDataViewport DXFLayout DXFGraphic BlockRecordezdxfc8|j|}|jSN)entitydb entity_space)docblock_record_handle block_records 4lib/python3.12/site-packages/ezdxf/layouts/layout.pyget_block_entity_spacer s<< 34L  $ $$ceZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZd0fd Zed1d2dZed0dZed3dZed4dZed3dZd5dZd6dZd5fd Zed7dZ d8 d5dZd9d5dZd:d;dZ d d?dZ#d@d Z$dAdBd!Z%dAdBd"Z&dAdBd#Z'dAdBd$Z(dAdBd%Z)dAdBd&Z*dAdBd'Z+dAdBd(Z,dAdBd)Z-dAdBd*Z.dAdBd+Z/dAdBd,Z0dAdBd-Z1dAdBd.Z2dAdBd/Z3xZ4S)CLayoutas Layout representation - base class for :class:`Modelspace` and :class:`Paperspace` Every layout consist of a LAYOUT entity in the OBJECTS section, an associated BLOCK in the BLOCKS section and a BLOCK_RECORD_TABLE entry. layout_key: handle of the BLOCK_RECORD, every layout entity has this handle as owner attribute (entity.dxf.owner) There are 3 different layout types: 1. :class:`Modelspace` 2. active :class:`Paperspace` layout 3. inactive :class:`Paperspace` layout Internal Structure For every layout exist a :class:`BlockLayout` object in :class:`BlocksSection` and a :class:`Layout` object (as :class:`Modelspace` or :class:`Paperspace`) in :class:`Layouts`. The entity space of the :class:`BlockLayout` object and the entity space of the :class:`Layout` object are the same object. r @iiiii i@c ||_|jjdd} |j|}|jdk7r@t jd|d|jjd |j|jj|j_ t|5|y#t$r@t |}|0t jd|d|jjdYwxYw) Nr0zrequired BLOCK_RECORD #z for layout 'z' does not exist BLOCK_RECORDzexpected BLOCK_RECORD(#z) for layout 'z' has invalid entity type: ) dxf_layoutdxfgetrKeyError_find_layout_block_recordr DXFStructureErrornamedxftypehandlelayoutsuper__init__)selfr7rr6r __class__s rr9zLayout.__init__Ls   5s; <</L    !^ 3)))& ?PQ,,8,@,@,B+CE  #)**"3"3  & 4V block_layoutr.s rr@z Layout.newasg %(JJNN:$> %2 '3'G'G  [[++H+L :s##r!c8|||}|j|S)z!Loading interface. (internal API))_repair_owner_tags)rDr7r_layouts rloadz Layout.load|s!fc"""$r!cB|jjjS)z9Layout name as shown in tabs of :term:`CAD` applications.r.r/r4r:s rr4z Layout.names""'''r!c.|jjS)zReturns the DXF name space attribute of the associated :class:`~ezdxf.entities.DXFLayout` object. This enables direct access to the underlying LAYOUT entity, e.g. ``Layout.dxf.layout_flags`` )r.r/rMs rr/z Layout.dxfs"""r!cB|jjjS)z:Returns the name of the associated BLOCK_RECORD as string.)rr/r4rMs rblock_record_namezLayout.block_record_names  $$)))r!c|j}|jrdnd}|D]W}|jj|k7r||j_|jj|k7sG||j_Yy)zmSet `owner` and `paperspace` attributes of entities hosted by this layout to correct values. rrN) layout_key is_modelspacer/owner paperspace)r:rRrUentitys rrHzLayout._repair_owner_tagssb__ ,,Q! Fzz:-#-  zz$$ 2(2 % r!ct|tr|j|}|jj|j k(S)zReturns ``True`` if `entity` is stored in this layout. Args: entity: :class:`DXFGraphic` object or handle as hex string ) isinstancestrrr/rTrR)r:rVs r __contains__zLayout.__contains__s5 fc "]]6*Fzz4??22r!c|jjj|jt|y)zDelete all entities and the layout itself from entity database and all linked structures. (internal API) N)rrB delete_entityr.r8destroy)r:r;s rr]zLayout.destroys+ &&t7 r!cB|jjjSr)r.r/plot_layout_flagsrMs rr_zLayout.plot_layout_flagss""444r!cL|jj}||_||_y)alReset `extents`_ to given values or the AutoCAD default values. "Drawing extents are the bounds of the area occupied by objects." (Quote Autodesk Knowledge Network) Args: extmin: minimum extents or (+1e20, +1e20, +1e20) as default value extmax: maximum extents or (-1e20, -1e20, -1e20) as default value N)r.r/extminextmax)r:rarbr/s r reset_extentszLayout.reset_extentss!oo!!  r!c|jj}|d}||j|jf}||_||_y)a_Reset `limits`_ to given values or the AutoCAD default values. "Sets an invisible rectangular boundary in the drawing area that can limit the grid display and limit clicking or entering point locations." (Quote Autodesk Knowledge Network) The :class:`Paperspace` class has an additional method :meth:`~Paperspace.reset_paper_limits` to deduce the default limits from the paper size settings. Args: limmin: minimum limits or (0, 0) as default limmax: maximum limits or (paper width, paper height) as default value Nrr)r.r/ paper_width paper_heightlimminlimmax)r:rhrir/s r reset_limitszLayout.reset_limitssD oo!! >F >oos'7'78F  r!c~dt|cxkrdkrnn||j_ytjd)a& === ============================================================ 0 last screen display 1 drawing extents 2 drawing limits 3 view specific (defined by :attr:`Layout.dxf.plot_view_name`) 4 window specific (defined by :meth:`Layout.set_plot_window_limits`) 5 layout information (default) === ============================================================ Args: value: plot type Raises: DXFValueError: for `value` out of range rz#Plot type value out of range (0-5).N)intr/ plot_typer DXFValueError)r:values r set_plot_typezLayout.set_plot_types3$ E a !&DHH %%&KL Lr!c~||jj_|jd|j |y)zSet plot style file of type `.ctb`. Args: name: plot style filename show: show plot style effect in preview? (AutoCAD specific attribute) TN)r.r/current_style_sheetuse_plot_stylesshow_plot_styles)r:r4shows rset_plot_stylezLayout.set_plot_styles237/ T" d#r!cB|jjjSr)r.r/rsrMs rget_plot_style_filenamezLayout.get_plot_style_filename s""666r!c|\}}|\}}|jj}||_||_||_||_|j dy)zSet plot window size in (scaled) paper space units. Args: lower_left: lower left corner as 2D point upper_right: upper right corner as 2D point r%N)r.r/plot_window_x1plot_window_y1plot_window_x2plot_window_y2rq)r: lower_left upper_rightx1y1x2y2r/s rset_plot_windowzLayout.set_plot_windowsSBBoo!! 1r!c|jj}|jj}d}|r||z }|jjdk(r|S|dzS)N?rffffff9@)r/scale_denominatorscale_numeratorplot_paper_units)r:denom numeratorscales rget_plot_unit_scale_factorz!Layout.get_plot_unit_scale_factor#sS**HH,,  %E 88 $ $ )L4< r!c<|j|j|yr)set_plot_flagsPLOT_VIEWPORT_BORDERSr:states rplot_viewport_borderszLayout.plot_viewport_borders/s D66>r!c<|j|j|yr)rSHOW_PLOT_STYLESrs rruzLayout.show_plot_styles2s D1159r!c<|j|j|yr)r PLOT_CENTEREDrs r plot_centeredzLayout.plot_centered5s D..6r!c<|j|j|yr)r PLOT_HIDDENrs r plot_hiddenzLayout.plot_hidden8s D,,e4r!c<|j|j|yr)rUSE_STANDARD_SCALErs ruse_standard_scalezLayout.use_standard_scale;s D33U;r!c<|j|j|yr)rPLOT_PLOTSTYLESrs rrtzLayout.use_plot_styles>s D00%8r!c<|j|j|yr)rSCALE_LINEWEIGHTSrs rscale_lineweightszLayout.scale_lineweightsA D22E:r!c<|j|j|yr)rPRINT_LINEWEIGHTSrs rprint_lineweightszLayout.print_lineweightsDrr!c<|j|j|yr)rDRAW_VIEWPORTS_FIRSTrs rdraw_viewports_firstzLayout.draw_viewports_firstGs D55u=r!c<|j|j|yr)r MODEL_TYPErs r model_typezLayout.model_typeJs DOOU3r!c<|j|j|yr)r UPDATE_PAPERrs r update_paperzLayout.update_paperM D--u5r!c<|j|j|yr)rZOOM_TO_PAPER_ON_UPDATErs rzoom_to_paper_on_updatezLayout.zoom_to_paper_on_updatePs D88%@r!c<|j|j|yr)r INITIALIZINGrs rplot_flags_initializingzLayout.plot_flags_initializingSrr!c<|j|j|yr)rPREV_PLOT_INITrs rprev_plot_initzLayout.prev_plot_initVs D//7r!c@|jj||dy)Nr_)rr4)r.set_flag_state)r:flagrs rrzLayout.set_plot_flagsYs &&t5?R&Sr!)r7rrrr)r4rYrErYrrreturnr#rrY)rrrNone)rVzUnion[DXFGraphic, str]rbool)rrm))@xDrr)@xrrNN)rl)rprmrr)z ezdxf.ctbF)r4rYrvrrr)rere)rtuple[float, float]rrrr)rfloat)T)rrrr)5__name__ __module__ __qualname____doc__rrrrrrrrrrrrrrr9 classmethodr@rJpropertyr4r/rPrHrZr]r_rcrjrqrwryrrrrurrrrtrrrrrrrrr __classcell__)r;s@rr#r# s8MKOJL"LN'*$$4 ((##** 3 3 554I "2M. $7 +1+1')  *  ?:75<9;;>46A68TTr!r#c4eZdZdZeddZdddZd dZy) Modelspacez:class:`Modelspace` - not deletable, all entities of this layout are stored in the ENTITIES section of the DXF file, the associated "*Model_Space" block is empty, block name is fixed as "*Model_Space", the name is fixed as "Model". cy)z'Name of modelspace is fixed as "Model".ModelrMs rr4zModelspace.nameesr!Nc:|jjtjkrtjd|i}|j }|jj j|jjj|}||d<|S)aCreates a new :class:`GeoData` entity and replaces existing ones. The GEODATA entity resides in the OBJECTS section and not in the modelspace, it is linked to the modelspace by an :class:`~ezdxf.entities.ExtensionDict` located in BLOCK_RECORD of the modelspace. The GEODATA entity requires DXF R2010. The DXF reference does not document if other layouts than the modelspace supports geo referencing, so I assume getting/setting geo data may only make sense for the modelspace. Args: dxfattribs: DXF attributes for :class:`~ezdxf.entities.GeoData` entity z+GEODATA entity requires DXF R2010 or later.)rTr>ACAD_GEOGRAPHICDATA) r dxfversionr DXF2010roget_extension_dictrB add_geodata dictionaryr/r6)r:r>xdictgeodatas r new_geodatazModelspace.new_geodatajs 88   .%%&ST T  J'')((""..""&&--!/ (/#$r!c |jj} |dS#t$rYywxYw#tj$rYywxYw)znReturns the :class:`~ezdxf.entities.GeoData` entity associated to the modelspace or ``None``. Nr)rrAttributeErrorr DXFKeyError)r:rs r get_geodatazModelspace.get_geodatasY %%88:E ./ /      s"1 ..AArr)rr)rzOptional[GeoData])rrrrrr4rrrr!rrr]s%: r!rceZdZdZddZddZddZ d ddZdZddZ ddd Z dd Z dd Z dd Z d dd ZddZddZ d d!dZddZy)" PaperspaceaThere are two kind of paperspace layouts: 1. Active Layout - all entities of this layout are stored in the ENTITIES section, the associated "*Paper_Space" block is empty, block name "*Paper_Space" is mandatory and also marks the active layout, the layout name can be an arbitrary string. 2. Inactive Layout - all entities of this layouts are stored in the associated BLOCK called "*Paper_SpaceN", where "N" is an arbitrary number, I don't know if the block name schema "*Paper_SpaceN" is mandatory, the layout name can be an arbitrary string. There is no different handling for active layouts and inactive layouts in `ezdxf`, this differentiation is just for AutoCAD important and it is not documented in the DXF reference. c:||jj_y)a#Rename layout to `name`, changes the name displayed in tabs by CAD applications, not the internal BLOCK name. (internal API) Use method :meth:`~ezdxf.layouts.Layouts.rename` of the :meth:`~ezdxf.layouts.Layouts` class to rename paper space layouts. NrL)r:r4s rrenamezPaperspace.renames$( r!cn|Dcgc]%}|js|jdk(s$|'c}Scc}w)z0 is on and active. The value indicates the order of stacking for the viewports, where 1 is the "active viewport", 2 is the next, ... VIEWPORTS)centerwidthheightrlayerview_center_point view_heightrr)rArrCget_next_viewport_idr/r) r:rsizerrrr>rrattribsrs r add_viewportzPaperspace.add_viewportsq* %2  v !2&   z" DOOJ$HI335 r!cR|j}|rtd|DdzSy)Nc3HK|]}|jjywr)r/r).0vps r z2Paperspace.get_next_viewport_id..s59Rrvvyy9s "rr$)rmax)r:rs rrzPaperspace.get_next_viewport_ids*NN$ 59559 9r!cp|jD]}|j||jy)z>Delete all existing viewports, and create a new main viewport.N)rr\add_new_main_viewport)r:rs rreset_viewportszPaperspace.reset_viewportss/(H   x () ""$r!c|j}||j}|j\}}||}||}||j_|\}}||j_||j_|S)aReset the main viewport of this paper space layout to the given values, or reset them to the default values, deduced from the paper settings. Creates a new main viewport if none exist. Ezdxf does not create a main viewport by default, because CAD applications don't require one. Args: center: center of the viewport in paper space units size: viewport size as (width, height) tuple in paper space units )rrdefault_viewport_configr/rrr)r:rrrdefault_center default_sizerrs rreset_main_viewportzPaperspace.reset_main_viewports%%'  113H'+'C'C'E$ >#F <D$  v" $ r!c |jj}|jdk(rd nd |j|jz fd}||j }||j }||j}||j}|||jz ||jz }|||jz ||jz }|dz} |dz} |dz |z |dz |z f} | | | ffS)Nrrrc|z zSrr)rp scale_factor unit_factors r paper_unitsz7Paperspace.default_viewport_config..paper_units"s;&5 5r!皙?r$) r.r/rrrrfrgplot_origin_x_offsetplot_origin_y_offset left_margin right_margin bottom_margin top_margin)r:r/rrfrgx_offsety_offsetprintable_widthprintable_heightvp_width vp_heightrrrs @@rr z"Paperspace.default_viewport_configs$oo!!   1 $KK,,s/B/BB  6"#//2 "3#3#34 s778s778 +coo6 6SEUEU9V V  ;s'8'89 9Ks335 G ))$! *  t  !A %##'')C-' ''    $ $Q 6 "(  (():):)A)ABr!c:||jj_yr)r.r/viewport_handle)r:r6s rr%z&Paperspace.set_current_viewport_handleUs.4+r!c ft|dvrtjdt|trd} |\} } nKt|tr&|} tj j | d\} } ntjd| dk(rtjd| dk(rtjd|\} } |\}}}}|j}|jd rd }d}d }n!|d k(rd }d}d}ntjd|jj}|jds|jd|_|jdd|_||_|d| dd| dd|d|_||z|_||z|_||z|_||z|_| |z|_| |z|_| |_| |_||_||_|\}}||z|_||z|_| |_d|z |_ |jC|jE|jGy)aSetup plot settings and paper size and reset viewports. All parameters in given `units` (mm or inch). Reset paper limits, extents and viewports. Args: size: paper size as (width, height) tuple margins: (top, right, bottom, left) hint: clockwise units: "mm" or "inch" offset: plot origin offset is 2D point rotation: see table Rotation scale: integer in range [0, 32] defines a standard scale type or as tuple(numerator, denominator) e.g. (1, 50) for scale 1:50 name: paper name prefix "{name}_({width}_x_{height}_{unit})" device: device .pc3 configuration file or system printer name === ============ int Rotation === ============ 0 no rotation 1 90 degrees counter-clockwise 2 upside-down 3 90 degrees clockwise === ============ rrr$zvalid rotation values: 0-3r')rrz9Scale has to be an int or a tuple(numerator, denominator)rScale numerator can't be 0.Scale denominator can't be 0.inchInchesrmmMMrr Supported units: "mm" and "inch"r_Fz_(z.2f_x__)N)$rmr rorXtuple STD_SCALESr0 DXFTypeErrorlower startswithr.r/r get_defaultr_rpage_setup_nameplot_configuration_file paper_sizerrrrrfrgrrr plot_rotationrrstandard_scale_typerreset_paper_limitsrcr)r:rmarginsunitsoffsetrotationrr4devicestandard_scale scale_num scale_denomrfrg margin_top margin_right margin_bottom margin_leftrrr/rrs r page_setupzPaperspace.page_setupXs[J x= ,%%&BC C eU #N%* "I{ s #"N%*%5%5%9%9.*%U "I{$$K  >%%&CD D ! %%&EF F$(! \?F< L-    F #E K d]E K%%&HI Ioo!!{{./$'OO4G$HC ! & &,# 6K#4C S7I5'QRS% 3)K7'+5#k1% 3'+5' +/$#(#+k#9 #+k#9 "0 + !  r!cT|jj}|jdk(rd}nd}|j|z }|j|z }|j |z }|j |z }|j|z }|j|z }||z} ||z} | | f|_ || z || z f|_ y)zpSet paper limits to default values, all values in paperspace units but without plot scale (?). rrrN) r.r/rrfrgrrrrrhri) r:r/rrfrgrrrrshift_xshift_ys rrBzPaperspace.reset_paper_limitss oo!!   1 $KKoo 3 ''+5 oo 3 ))K7 ++k9++k9((*h) !G+\G-CD r!c~t|jjt|jjfS)a-Returns paper limits in plot paper units, relative to the plot origin. plot origin = lower left corner of printable area + plot origin offset Returns: tuple (Vec2(x1, y1), Vec2(x2, y2)), lower left corner is (x1, y1), upper right corner is (x2, y2). )r r/rhrirMs rget_paper_limitszPaperspace.get_paper_limitss)DHHOO$d488??&;;;r!c(|jD]}|j|t|dvrtjdt |tr$tj j|d\}} n|\}} |dk(rtjd| dk(rtjd| |z |j}|jdrd}d} d } n!|d k(rd }d } d } ntjdfd} | |d} | |d }| |d}| |d}| |d}| |d }d|jjd<||f|jjd<d|jjd<||df|jjd<||z |z }||z | z }|dz}|dz}|dz |dz f}|j|||f||d }d |j_d|j_y)Nr*zValid rotation values: 0-3)rrrr,r-r.r/rr0r1rrr2c|zSrr)rprs rrz.Paperspace.page_setup_r12..paper_units s<' 'r!r$r+re$PLIMMIN$PLIMMAX)rrrz$PEXTMINz$PEXTMAXrr i)rr\rmr rorXr8r0r:r;rheaderrr/r render_mode)r:rrCrDrErFrrrIrJrrrrKrLrMrNrfrgrrrrrrrs @rpage_setup_r12zPaperspace.page_setup_r12sL(H   x () x= ,%%&BC C eS !%*%5%5%9%9%%H "I{%* "I{ >%%&CD D ! %%&EF F"Y.     F #E K d]E K%%&HI I (!, "71:. #GAJ/ !'!*- !$q'* "47+ &, #'2L&A #&/ #'2L!&D #& 3lB'-7*D$ 3& "A%'7!';<))I&$! *  ! (, %r!c|jjjdd}|jjjdd}t|t|fS)z)Returns paper limits in plot paper units.rWrerX)rrYr0r )r:rhris rget_paper_limits_r12zPaperspace.get_paper_limits_r12.sI$$Z8$$Z8F|T&\))r!)r4rYrr)rzlist[Viewport])rzOptional[Viewport])r$N) rr rrrr rrrrmrrrr)rr rr rr)rz/tuple[tuple[float, float], tuple[float, float]])rr)r6rYrr)i)rrrrr0rerr'rzDWG to PDF.pc3)rrrC!tuple[float, float, float, float]rDrYrErrFrmrUnion[int, tuple[float, float]]r4rYrGrYrr)rztuple[Vec2, Vec2])r^r`r0rerr')rrrCrarDrYrErrFrrrbrr)rrrrrrrrrrr r rr%rOrBrTr[r]rr!rrrs~$ (M *$$"$ $  $  $ $L %8'- 8'-R.5 %/5A&,13&a!a3a a $ a  a/aaa aFE2 <%/5A&,13L-!L-3L- L- $ L-  L-/L- L-\*r!rc dfd jJjjdk(rUtd}jj D]0}t|jj|k(s&||cSytd}jj Dcgc]2}t|jjj |r|4c}fd}|}||d}|Scc}w)z@Find and link the lost BLOCK_RECORD for the given LAYOUT entity.c "tjdjjdt dt ||jj j_jj |j_y)Nzfixing broken links for 'z ' between z and )loggerinfor/r4rYr6rr7)rr7s r link_layoutz._find_layout_block_record..link_layout8sl ' '8 3v;-uUXYeUfTg h *6)9)9)@)@ &"(**"3"3 r!Nrz *Model_Spacez *Paper_SpacecD]G}|jjdd}jj||us=||cSy)Nr7r,)r/r0r)keyr layout_handlerrgpaper_space_recordss rsearchz)_find_layout_block_record..searchQsO/L(,,003?M|| .#5L)## 0 r!)rrrr)rr/r4r tables block_recordsr;)r7rir search_keyrlrrgrks` @@@rr2r25s4 **C ?? zz'!^,JJ44Ll..334;L)##5 /J JJ444L ,**// 0 ; ;J G 4 &>Ld| 's,7D)rrrrYrr )r7rrzBlockRecord | None)% __future__rtypingrrrrrlogging ezdxf.mathr r ezdxf.entitydbr ezdxf.lldxfr ezdxf.lldxf.validatorr baserezdxf.documentr ezdxf.layoutsrezdxf.entitiesrrrrr getLoggerrer r#rrr2rr!rr|s#!&0&)TT   7 #% zTZzTz 55p]*]*@ )r!