VS:IsPlanarObj: Difference between revisions

From Vectorworks Developer
Jump to navigation Jump to search
m (1 revision)
(Renamed "NewParam" into "refID", which is the name used for this variable everywhere else.)
Line 7: Line 7:
<def>
<def>
<funcDef lang="vs">
<funcDef lang="vs">
FUNCTION IsPlanarObj(object:HANDLE; VAR NewParam:LONGINT) : BOOLEAN;
FUNCTION IsPlanarObj(object:HANDLE; VAR refID:LONGINT) : BOOLEAN;
</funcDef>
</funcDef>
<funcDef lang="py">
<funcDef lang="py">
def vs.IsPlanarObj(object):
def vs.IsPlanarObj(object):
     return (BOOLEAN, NewParam)
     return (BOOLEAN, refID)
</funcDef>
</funcDef>
</def>
</def>
Line 24: Line 24:
</line>
</line>
<line>
<line>
NewParam
refID
LONGINT
LONGINT
If object is planar, returns the planar refID of its plane
If object is planar, returns the planar refID of its plane
Line 32: Line 32:


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<remark></remark>
<remark>
([[User:Orso.b.schmid|Orso]], 2020.05.17)
Renamed "NewParam" into "refID", which is the name used for this variable everywhere else.
</remark>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------

Revision as of 03:11, 17 May 2020

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

Description

FUNCTION IsPlanarObj(
object :HANDLE;
VAR refID :LONGINT) : BOOLEAN;
def vs.IsPlanarObj(object):
    return (BOOLEAN, refID)

Parameters

object HANDLE Object to test
refID LONGINT If object is planar, returns the planar refID of its plane

Remarks

(Orso, 2020.05.17)

Renamed "NewParam" into "refID", which is the name used for this variable everywhere else.

Version

Availability: from Vectorworks 2016