Skip to content

Commit

Permalink
Update for 2023.1.315 Release
Browse files Browse the repository at this point in the history
  • Loading branch information
hilliard committed Sep 6, 2023
1 parent a760a16 commit 610e92d
Show file tree
Hide file tree
Showing 13 changed files with 3,484 additions and 1,977 deletions.
212 changes: 211 additions & 1 deletion Layout/Document.html
Original file line number Diff line number Diff line change
Expand Up @@ -773,6 +773,54 @@ <h2>
<p>The <span class='object_link'><a href="#remove_entity-instance_method" title="Layout::Document#remove_entity (method)">#remove_entity</a></span> method removes an <span class='object_link'><a href="Entity.html" title="Layout::Entity (class)">Entity</a></span> from the <span class='object_link'><a href="" title="Layout::Document (class)">Document</a></span>.</p>
</div></span>

</li>


<li class="public ">
<span class="summary_signature">

<a href="#render_mode_override-instance_method" title="#render_mode_override (instance method)">#<strong>render_mode_override</strong> &#x21d2; Integer </a>



</span>









<span class="summary_desc"><div class='inline'>
<p>The <span class='object_link'><a href="#render_mode_override-instance_method" title="Layout::Document#render_mode_override (method)">#render_mode_override</a></span> method returns the override setting for output render modes of <span class='object_link'><a href="SketchUpModel.html" title="Layout::SketchUpModel (class)">SketchUpModel</a></span>s in the <span class='object_link'><a href="" title="Layout::Document (class)">Document</a></span>.</p>
</div></span>

</li>


<li class="public ">
<span class="summary_signature">

<a href="#render_mode_override=-instance_method" title="#render_mode_override= (instance method)">#<strong>render_mode_override=</strong>(render_mode) &#x21d2; Object </a>



</span>









<span class="summary_desc"><div class='inline'>
<p>The <span class='object_link'><a href="#render_mode_override=-instance_method" title="Layout::Document#render_mode_override= (method)">#render_mode_override=</a></span> method sets the override setting for output render modes of <span class='object_link'><a href="SketchUpModel.html" title="Layout::SketchUpModel (class)">SketchUpModel</a></span>s in the <span class='object_link'><a href="" title="Layout::Document (class)">Document</a></span>.</p>
</div></span>

</li>


Expand Down Expand Up @@ -1632,7 +1680,6 @@ <h3 class="signature " id="export-instance_method">
</span><span class='comment'># first page of a {Layout::Document} is index 0.
</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>start_page:</span> <span class='int'>1</span><span class='comma'>,</span>
<span class='label'>end_page:</span> <span class='int'>3</span><span class='comma'>,</span>
<span class='label'>output_resolution:</span> <span class='const'><span class='object_link'><a href="../Layout.html" title="Layout (module)">Layout</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="PageInfo.html" title="Layout::PageInfo (class)">PageInfo</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="PageInfo.html#RESOLUTION_HIGH-constant" title="Layout::PageInfo::RESOLUTION_HIGH (constant)">RESOLUTION_HIGH</a></span></span><span class='comma'>,</span>
<span class='label'>compress_images:</span> <span class='const'>TRUE</span><span class='comma'>,</span>
<span class='label'>compress_quality:</span> <span class='float'>0.75</span> <span class='rbrace'>}</span>

Expand Down Expand Up @@ -2589,6 +2636,169 @@ <h3 class="signature " id="remove_entity-instance_method">

</ul>

</div>
</div>

<div class="method_details ">
<h3 class="signature " id="render_mode_override-instance_method">
<a style="float: right;" href="#header" title="Return to Top">&uarr;</a>

#<strong>render_mode_override</strong> &#x21d2; <tt>Integer</tt>





</h3><div class="docstring">
<div class="discussion">

<p>The <span class='object_link'><a href="#render_mode_override-instance_method" title="Layout::Document#render_mode_override (method)">#render_mode_override</a></span> method returns the override setting for output render modes of <span class='object_link'><a href="SketchUpModel.html" title="Layout::SketchUpModel (class)">SketchUpModel</a></span>s in the <span class='object_link'><a href="" title="Layout::Document (class)">Layout::Document</a></span>.</p>


</div>
</div>
<div class="tags">

<div class="examples">
<p class="tag_title">Examples:</p>


<pre class="example code"><code><span class='id identifier rubyid_doc'>doc</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Layout.html" title="Layout (module)">Layout</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Layout::Document (class)">Document</a></span></span><span class='period'>.</span><span class='id identifier rubyid_open'><span class='object_link'><a href="#open-class_method" title="Layout::Document.open (method)">open</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>C:/path/to/document.layout</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_render_mode'>render_mode</span> <span class='op'>=</span> <span class='id identifier rubyid_doc'>doc</span><span class='period'>.</span><span class='id identifier rubyid_render_mode_override'>render_mode_override</span></code></pre>

</div>

<p class="tag_title">Returns:</p>
<ul class="return">

<li>


<span class='type'>(<tt>Integer</tt>)</span>



</li>

</ul>
<p class="tag_title">Version:</p>
<ul class="version">

<li>





<div class='inline'>
<p>LayOut 2023.1</p>
</div>

</li>

</ul>

</div>
</div>

<div class="method_details ">
<h3 class="signature " id="render_mode_override=-instance_method">
<a style="float: right;" href="#header" title="Return to Top">&uarr;</a>

#<strong>render_mode_override=</strong>(render_mode) &#x21d2; <tt>Object</tt>





</h3><div class="docstring">
<div class="discussion">

<p>The <span class='object_link'><a href="#render_mode_override=-instance_method" title="Layout::Document#render_mode_override= (method)">#render_mode_override=</a></span> method sets the override setting for output render modes of <span class='object_link'><a href="SketchUpModel.html" title="Layout::SketchUpModel (class)">SketchUpModel</a></span>s in the <span class='object_link'><a href="" title="Layout::Document (class)">Layout::Document</a></span>. Setting this to <code>NO_OVERRIDE</code> will prevent overriding the individual <span class='object_link'><a href="SketchUpModel.html" title="Layout::SketchUpModel (class)">SketchUpModel</a></span> render mode setting during export. This override will only affect raster rendered <span class='object_link'><a href="SketchUpModel.html" title="Layout::SketchUpModel (class)">SketchUpModel</a></span>s, if a viewport is set to vector or hybrid, it will retain that render mode as its output render mode.</p>


</div>
</div>
<div class="tags">

<div class="examples">
<p class="tag_title">Examples:</p>


<pre class="example code"><code><span class='id identifier rubyid_doc'>doc</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Layout.html" title="Layout (module)">Layout</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Layout::Document (class)">Document</a></span></span><span class='period'>.</span><span class='id identifier rubyid_open'><span class='object_link'><a href="#open-class_method" title="Layout::Document.open (method)">open</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>C:/path/to/document.layout</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_doc'>doc</span><span class='period'>.</span><span class='id identifier rubyid_render_mode_override'>render_mode_override</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Layout.html" title="Layout (module)">Layout</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="SketchUpModel.html" title="Layout::SketchUpModel (class)">SketchUpModel</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="SketchUpModel.html#VECTOR_RENDER-constant" title="Layout::SketchUpModel::VECTOR_RENDER (constant)">VECTOR_RENDER</a></span></span></code></pre>

</div>
<p class="tag_title">Parameters:</p>
<ul class="param">

<li>

<span class='name'>render_mode</span>


<span class='type'>(<tt>Integer</tt>)</span>



&mdash;
<div class='inline'>
<p><code>NO_OVERRIDE</code>, <code>VECTOR_RENDER</code>, or <code>HYBRID_RENDER</code></p>
</div>

</li>

</ul>

<p class="tag_title">Raises:</p>
<ul class="raise">

<li>


<span class='type'>(<tt>ArgumentError</tt>)</span>



&mdash;
<div class='inline'>
<p>if render_mode is not a valid render mode</p>
</div>

</li>

<li>


<span class='type'>(<tt>ArgumentError</tt>)</span>



&mdash;
<div class='inline'>
<p>if render_mode is <code>RASTER_RENDER</code></p>
</div>

</li>

</ul>
<p class="tag_title">Version:</p>
<ul class="version">

<li>





<div class='inline'>
<p>LayOut 2023.1</p>
</div>

</li>

</ul>

</div>
</div>

Expand Down
Loading

0 comments on commit 610e92d

Please sign in to comment.