View source for VS:vsoStateGetPos

{{LocationMain|category=LocationVS|specific=}}
__TOC__
<vwDoc>

-----------------------------------------------------------------------------------------------------------
<desc>
Used to determine if an object has been moved. Returns True if the object was moved and the distance the object was moved in mm. See [[VS:Parametric State Notifications#vsoStateGetPos]]

This function should be called during the parametric reset event: <code>3: {kParametricRecalculate}</code>

</desc>

-----------------------------------------------------------------------------------------------------------
<def>
<funcDef lang="vs">
FUNCTION vsoStateGetPos(hObj: HANDLE; VAR outX: REAL; VAR outY: REAL; VAR outZ: REAL; VAR outIs3D: BOOLEAN) : BOOLEAN;
</funcDef>
<funcDef lang="py">
def vs.vsoStateGetPos(hObj):
    return (BOOLEAN, outX, outY, outZ, outIs3D)
</funcDef>
</def>

-----------------------------------------------------------------------------------------------------------
<params>
<lineList ident=1>
<line>
hObj
HANDLE
Handle to the parametric object. Obtained by call to [[VS:GetCustomObjectInfo]]
</line>
<line>
outX
REAL
Output parameter. Moved distance in mm.
</line>
<line>
outY
REAL
Output parameter. Moved distance in mm.
</line>
<line>
outZ
REAL
Output parameter. Moved distance in mm.
</line>
<line>
outIs3D
BOOLEAN
Output parameter. Is 3D operation.
</line>
</lineList>
</params>


-----------------------------------------------------------------------------------------------------------
<return>
Returns True if the object was moved.
</return>

-----------------------------------------------------------------------------------------------------------
<remark>
Returns the distance moved (NOT the previous x,y,z location) in mm.
</remark>

-----------------------------------------------------------------------------------------------------------
<sample>
==== VectorScript ====
<code lang="pas">
BEGIN
  result := GetCustomObjectInfo(objectName, objectHand, recordHand, wallHand);
  vsoGetEventInfo(theEvent, message );

  CASE theEvent OF
    5: {kObjOnInitXProperties}
    BEGIN
      {enable eventing for this plug-in}
      SetPrefInt( 590, 1 ); {varParametricEnableStateEventing, kParametricStateEvent_ResetStatesEvent}
      result := SetObjPropVS(18, TRUE); {kObjXPropAcceptStates}
    END;	

    44: {kObjOnAddState}
    BEGIN
      message := vsoStateAddCurrent( objectHand, message );
    END;

    3: {kParametricRecalculate}
    BEGIN
      MoveTo( 5mm, 8mm );
      CreateText( 'State events received after the last kParametricRecalculate:' );
 
      IF vsoStateGetPos( objectHand, x, y, z, is3D ) THEN BEGIN
        MoveTo( 0,-10mm );
        CreateText( Concat( 'Object just moved! offset=(', x, ' ,', y, ' ,', y, ' z', z, ') is3DMove=', is3D ) );
        END;
    END;

</code>
==== Python ====
<code lang="py">

</code>
</sample>

-----------------------------------------------------------------------------------------------------------
<version>
Availability: from Vectorworks2009
This is drop-in function.
</version>

-----------------------------------------------------------------------------------------------------------
<seeAlso>
[[VS:Parametric State Notifications]] | [[VS:vsoStateAddCurrent]]

[[VS:vsoStateGetPos]] | [[VS:vsoStateGetRot]] | [[VS:vsoStateGetParamChng]] | [[VS:vsoStateGetObjChng]] | [[VS:vsoStateGetLayrChng]] | [[VS:vsoStateGetExitGroup]] | [[VS:vsoStateGetNameChng]]
</seeAlso>

</vwDoc>

[[Category:VS Function Reference|vsoStateGetPos]]
[[Category:VS Function Reference:Object Events|vsoStateGetPos]]