VS:GetWallHeight: Difference between revisions

From Vectorworks Developer
Jump to navigation Jump to search
m (1 revision)
No edit summary
Line 5: Line 5:
-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<desc>
<desc>
Returns the start & end, top & bottom heights of the referenced wall object.
Returns the height at the start and at the end of a wall.</desc>
</desc>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<def>
<def>
<funcDef lang="vs">
<funcDef lang="vs">
PROCEDURE GetWallHeight(hWall :HANDLE; VAR dStartTopHght :REAL; VAR dStartBotHght :REAL; VAR dEndTopHght :REAL; VAR dEndBotHght :REAL);
PROCEDURE GetWallHeight(hWall:HANDLE; VAR dStartTopHght:REAL; VAR dStartBotHght:REAL; VAR dEndTopHght:REAL; VAR dEndBotHght:REAL);
</funcDef>
</funcDef>
<funcDef lang="py">
<funcDef lang="py">
Line 30: Line 29:
dStartTopHght
dStartTopHght
REAL
REAL
Output parameter.
 
</line>
</line>
<line>
<line>
dStartBotHght
dStartBotHght
REAL
REAL
Output parameter.
 
</line>
</line>
<line>
<line>
dEndTopHght
dEndTopHght
REAL
REAL
Output parameter.
 
</line>
</line>
<line>
<line>
dEndBotHght
dEndBotHght
REAL
REAL
Output parameter.
 
</line>
</line>
</lineList>
</lineList>
</params>
</params>


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


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<remark>
<sample></sample>
 
</remark>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<sample>
<seeAlso></seeAlso>
<code lang="pas">
PROCEDURE Example;
VAR
  hWall        :HANDLE;
  dStartTopHght :REAL;
  dStartBotHght :REAL;
  dEndTopHght  :REAL;
  dEndBotHght  :REAL;
BEGIN
  hWall := FSActLayer;
  GetWallHeight(hWall, dStartTopHght, dStartBotHght, dEndTopHght, dEndBotHght);
  Message(dStartTopHght, ' ', dStartBotHght, ' ', dEndTopHght, ' ', dEndBotHght);
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>


[[Category:VS Function Reference|GetWallHeight]]
[[Category:VS Function Reference|GetWallHeight]]
[[Category:VS Function Reference:Objects - Walls|GetWallHeight]]
[[Category:VS Function Reference:Graphic Calculation|GetWallHeight]]

Revision as of 17:35, 18 September 2013

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

Description

Returns the height at the start and at the end of a wall.

PROCEDURE GetWallHeight(
hWall :HANDLE;
VAR dStartTopHght :REAL;
VAR dStartBotHght :REAL;
VAR dEndTopHght :REAL;
VAR dEndBotHght :REAL);
def vs.GetWallHeight(hWall):
    return (dStartTopHght, dStartBotHght, dEndTopHght, dEndBotHght)

Parameters

hWall HANDLE
dStartTopHght REAL
dStartBotHght REAL
dEndTopHght REAL
dEndBotHght REAL

Version

Availability: from Vectorworks 2014