VS:RetrieveCustomRWPrefs: Difference between revisions

From Vectorworks Developer
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
 
(One intermediate revision by the same user not shown)
Line 5: Line 5:
-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<desc>
<desc>
Returns current Custom RenderWorks settings.
Retrieves the current custom RenderWorks rendering preferences from data stored in the current drawing.</desc>
</desc>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<def>
<def>
<funcDef lang="vs">
<funcDef lang="vs">
PROCEDURE RetrieveCustomRWPrefs(VAR useTextures :BOOLEAN; VAR useTransparency :BOOLEAN; VAR useShadows :BOOLEAN; VAR useRayTracing :BOOLEAN; VAR useAntiAliasing :BOOLEAN; VAR useDithering :BOOLEAN; VAR tessellationDetail :INTEGER; VAR shadowStyle :INTEGER; VAR rayT
PROCEDURE RetrieveCustomRWPrefs(VAR useTextures:BOOLEAN; VAR useTransparency:BOOLEAN; VAR useShadows:BOOLEAN; VAR useRayTracing:BOOLEAN; VAR useAntiAliasing:BOOLEAN; VAR useDithering:BOOLEAN; VAR tessellationDetail:INTEGER; VAR shadowStyle:INTEGER; VAR rayTracingRecursion:INTEGER);
</funcDef>
</funcDef>
<funcDef lang="py">
<funcDef lang="py">
Line 19: Line 18:
</def>
</def>


-----------------------------------------------------------------------------------------------------------
<params>
<lineList ident=1>
<line>
useTextures
BOOLEAN
</line>
<line>
useTransparency
BOOLEAN
</line>
<line>
useShadows
BOOLEAN
</line>
<line>
useRayTracing
BOOLEAN
</line>
<line>
useAntiAliasing
BOOLEAN
</line>
<line>
useDithering
BOOLEAN
</line>
<line>
tessellationDetail
INTEGER
</line>
<line>
shadowStyle
INTEGER
</line>
<line>
rayTracingRecursion
INTEGER
</line>
</lineList>
</params>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<return>
<remark></remark>
</return>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<remark>
<sample></sample>
[orso, 2008-03-18]: It looks like this routine is now sort of obsolete: always returns FALSE and 0-values, unregarded the current custom RW settings [VW 13.0.1 -(83388)].
</remark>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<sample>
<seeAlso></seeAlso>
<code lang="pas">
PROCEDURE Example;
TYPE
  RWPrefStruct = STRUCTURE
      useTextures        :BOOLEAN;
      useTransparency    :BOOLEAN;
      useShadows        :BOOLEAN;
      useRayTracing      :BOOLEAN;
      useAntiAliasing    :BOOLEAN;
      useDithering      :BOOLEAN;
      tessellationDetail :INTEGER;
      shadowStyle        :INTEGER;
      rayTraceRecursion  :INTEGER;
  END;
VAR
  RWSettings :RWPrefStruct;
BEGIN
  RetrieveCustomRWPrefs(
      RWSettings.useTextures,
      RWSettings.useTransparency,
      RWSettings.useShadows,
      RWSettings.useRayTracing,
      RWSettings.useAntiAliasing,
      RWSettings.useDithering,
      RWSettings.tessellationDetail,
      RWSettings.shadowStyle,
      RWSettings.rayTraceRecursion);
END;
RUN(Example);</code>
 
</sample>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<version>
<version>
Availability: from All Versions
Availability: from Vectorworks 2014


This is drop-in function.
</version>
</version>
-----------------------------------------------------------------------------------------------------------
<seeAlso>
</seeAlso>


</vwDoc>
</vwDoc>

Latest revision as of 17:37, 18 September 2013

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

Retrieves the current custom RenderWorks rendering preferences from data stored in the current drawing.

PROCEDURE RetrieveCustomRWPrefs(
VAR useTextures :BOOLEAN;
VAR useTransparency :BOOLEAN;
VAR useShadows :BOOLEAN;
VAR useRayTracing :BOOLEAN;
VAR useAntiAliasing :BOOLEAN;
VAR useDithering :BOOLEAN;
VAR tessellationDetail :INTEGER;
VAR shadowStyle :INTEGER;
VAR rayTracingRecursion :INTEGER);
def vs.RetrieveCustomRWPrefs():
    return (useTextures, useTransparency, useShadows, useRayTracing, useAntiAliasing, useDithering, tessellationDetail, shadowStyle, rayTracingRecursion)

Parameters

useTextures BOOLEAN
useTransparency BOOLEAN
useShadows BOOLEAN
useRayTracing BOOLEAN
useAntiAliasing BOOLEAN
useDithering BOOLEAN
tessellationDetail INTEGER
shadowStyle INTEGER
rayTracingRecursion INTEGER

Version

Availability: from Vectorworks 2014