VS:vsoStateGetParamChng: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (1 revision) |
(No difference)
|
Revision as of 14:39, 12 August 2013
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Used to determine if the object parameter has changed. See VS:Parametric State Notifications#vsoStateGetParamChng
This function should be called during the parametric reset event: 3: {kParametricRecalculate}
FUNCTION vsoStateGetParamChng(
hObj : HANDLE;
VAR outWidgID : LONGINT;
VAR outPrmIdx : INTEGER;
VAR outOldVal : STRING) : BOOLEAN;
def vs.vsoStateGetParamChng(hObj): return (BOOLEAN, outWidgID, outPrmIdx, outOldVal)
Parameters
hObj HANDLE Handle to the parametric object. Obtained by call to VS:GetCustomObjectInfo outWidgID LONGINT Output parameter. Widget ID of the changed parameter. outPrmIdx INTEGER Output parameter. Parameter index. outOldVal STRING Output parameter. String representation of the old value.
Example
VectorScript
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 vsoStateGetParamChng( objectHand, widgID, prmIndex, oldValue ) THEN BEGIN MoveTo( 0,-30mm ); CreateText( Concat( 'Object parameter just changed! widgetID=', widgID, ' paramIndex=', prmIndex,' OldValue=', oldValue ) ); END; END;
Python
Version
Availability: from Vectorworks 2009
This is drop-in function.
See Also
VS:Parametric State Notifications | VS:vsoStateAddCurrent
VS:vsoStateGetPos | VS:vsoStateGetRot | VS:vsoStateGetParamChng | VS:vsoStateGetObjChng | VS:vsoStateGetLayrChng | VS:vsoStateGetExitGroup | VS:vsoStateGetNameChng
[[VS:Parametric State Notifications]] | [[VS:vsoStateAddCurrent]]
[[VS:vsoStateGetPos]] | [[VS:vsoStateGetRot]] | [[VS:vsoStateGetParamChng]] | [[VS:vsoStateGetObjChng]] | [[VS:vsoStateGetLayrChng]] | [[VS:vsoStateGetExitGroup]] | [[VS:vsoStateGetNameChng]]