VS:IsPlanarObj: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
No edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 7: | Line 7: | ||
<def> | <def> | ||
<funcDef lang="vs"> | <funcDef lang="vs"> | ||
FUNCTION IsPlanarObj(object:HANDLE; VAR | 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, | return (BOOLEAN, refID) | ||
</funcDef> | </funcDef> | ||
</def> | </def> | ||
| Line 24: | Line 24: | ||
</line> | </line> | ||
<line> | <line> | ||
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> | ||
This function always seems to return 0 for refID, no matter which plane the object being tested is located. | |||
Use [[VS:GetPlanarRef|GetPlanarRef]] instead to find the planar refID of a given planar object. | |||
</remark> | |||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
Latest revision as of 15:30, 17 February 2023
.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
This function always seems to return 0 for refID, no matter which plane the object being tested is located.
Use GetPlanarRef instead to find the planar refID of a given planar object.
Version
Availability: from Vectorworks 2016