VS:SetCntrlPtVis

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

Description

Sets the visibility of the specified control point.

PROCEDURE SetCntrlPtVis(
             inCustomObj       :HANDLE;
             inContrlPtIndex   :INTEGER;
             inIsVisible       :BOOLEAN);

def vs.SetCntrlPtVis(inCustomObj, inContrlPtIndex, inIsVisible):
    return None

Parameters

inCustomObj		HANDLE
inContrlPtIndex		INTEGER
inIsVisible		BOOLEAN

Remarks

[Joshua Benghiat 2006/12/14]:

inContrlPtIndex is 1 based and matches the index in the name of the control point (i.e. CONTROLPOINT01X).

The procedure works both inside the PIO definition and from an external command.

The visibility status does not reset itself. That is, if you want to toggle visibility on and off, you need something like: IF boo THEN SetCntrlPtVis(obHan, 1, TRUE) ELSE SetCntrlPtVis(obHan, 1, FALSE);

[Julian Carr, 2007/3/23]: ...or more succinctly SetCntrlPtVis(ParmHan, 1, boo);

Version

Availability: from All Versions

This is drop-in function.