Software Customisation Reference Manual

Name	Type	Action
.description	STRING	Description of the event packet.
.priority	REAL	Priority of event within the event packets of the same description.
.initialisation	STRING	Action carried out when event packet is initially added to the event system.
.close	STRING	Action carried out just before the event packet is removed from the event system.
.action	STRING	Action carried out when all picks within the pick sequence has been completed.
.continue	STRING	Action carried out after the event packet has been removed from the event system.
.escape	STRING	Action carried out when the event packet is removed from the system using the <esc> key in the design graphic canvas.
.form	FORM	Form to be show when event packet is added to the event system.
.pickPacket	EDGPICKPACKET	Definition of pick sequence and types required for the event packet.
.remove	BOOLEAN	True if event is automatically removed when the pick sequence has been completed. False if event is to be reinstated, without the .initialisation action being carried out.
			.input	ARRAY	Contains information to be held local to the event packet, which can be used during its execution.

Name	Action
.navigate()	Standard navigate pick.
.elementPick(<prompt>)	Standard database element pick.
.plinePick(<prompt>)	Standard pline pick.
.anyPick(<prompt>)	Standard "any" pick.
.aidPick(<prompt>)	Standard graphical aid pick.
.definePosition(<prompt>)	Define basic positioning pick packet.
.defineCircle(<option>)	Define circle definition pick packet.
.definePoint(<option>)	Define point definition pick packet.
.defineLine(<option>)	Define line definition pick packet.
.definePlane(<option>)	Define plane definition pick packet.
.defineMeasure(<option>)	Define a pick sequence for performing a measure.

Method Name	Description
.navigate()	Standard navigation pick, this will reposition you at the element picked.
Arguments	Description
Packet Members	Settings
.description	Standard Navigate.
.priority	10.
.remove	True.
.input
Return Array	Description
None	None.

Method Name	Description
.elementPick(<prompt>)	Standard element pick, allows a database element to be picked from the design canvas.
Arguments	Description
<prompt>	Primary display prompt shown in the views information field.
Packet Members	Settings
.description	Standard Element Pick.
.priority	0.
.remove	False.
.input
Return Array	Description
[1] edgPickData	Standard event pick return object.

Method Name	Description
.plinePick(<prompt>)	Standard structural element pline pick.
Arguments	Description
<prompt>	Primary display prompt shown in the views information field.
Packet Members	Settings
.description	Standard Pline Pick.
.priority	0.
.remove	False.
.input
Return Array	Description
[1] edgPickData	Standard event pick return object.

Method Name	Description
.anyPick(<prompt>)	Standard "any" pick, allows element, pline, ppoint or graphical aid to be picked.
Arguments	Description
<prompt>	Primary display prompt shown in the views information field.
Packet Members	Settings.
.description	Standard ANy Pick.
.priority	0.
.remove	False.
.input
Return Array	Description
[1] edgPickData	Standard event pick return object.

Method Name	Description
.aidPick(<prompt>)	Standard graphical aid element pick.
Arguments	Description
<prompt>	Primary display prompt shown in the views information field.
Packet Members	Settings
.description	Standard Aid Pick.
.priority	0.
.remove	False.
.input
Return Array	Description
[1] edgPickData	Standard event pick return object.

Method Name	Description
.definePosition(<prompt>)	Standard position pick, display position control form used to define pick type selection and derive position filter.
Arguments	Description
<prompt>	Primary display prompt shown in the views information field.
Packet Members	Settings
.description	Basic Position.
.priority	0.
.remove	False.
.input
Return Array	Description
[1] edgPositionData	Event picked position return object, contains all pick data and derived position from the pick.

Method Name	Description
.defineCircle(<option>)	Method for defining a pick sequence to define a arc object using the graphics.
Argument (Option)	Description
3pnt	Derives an arc passing through 3 position picks.
diameter3D	Derives an arc whose diameter and X axes is through the first two positional picks. The third positional pick defines the relative Y axes of the arc definition.
radius3D	Derives an arc which is centred about the first positional pick, the second positional pick defines the radius and X-axes. The third positional pick defines the relative Y axes of the arc definition.
fixedRadius3D	Defines an arc centred on the first position pick, where the second and third positional pick defines the X and Y axes respectively. Radius is specified via the automatically displays input form.
fixedDiameter3D	Defines an arc centred on the first position pick, where the second and third positional pick defines the X and Y axes respectively. Diameter is specified via the automatically displays input form.
diameter2D	Derives an arc lying on the active working plane, where the diameter and X axes is through the two positional picks.
radius2D	Derives an arc lying on the active working plane, centred about the first positional pick, the second positional pick defines the radius and X-axes.
fixedRadius2D	Defines an arc lying on the active working plane, centred about the positional pick. Radius is specified via the automatically displays input form.
fixedDiameter2D	Defines an arc lying on the active working plane, centred about the positional pick. Diameter is specified via the automatically displays input form.
fillet	Defines an arc of radius specified via the automatically displays input form, that lies tangentially to the two picked lines.
tanTan	Defines an arc of radius specified via the automatically displays input form, that is tangential to the two picked arc elements. The third pick (positional) define the centre side of the arc.
pntTan	Defines an arc centred on the first pick (positional) which is tangential to the second pick (curved element).
fixedRadiusPntTan	Defines an arc with radius supplied by the automatically displayed input form, which lies on the line between the first pick (positional) and the picked curved element.
fixedRadiusPntPnt	Defines an arc centred on the first positional pick which is tangential to the second pick on a curved element.
derive	Derives an arc from the picked element.
tan3Lines	Derives an arc which fits between the three lines picked.
Packet Members	Settings
.description	Defined by option.
.priority	0.
.remove	True.
.input
Return Array	Description
[1] arc	Standard arc object.

Method Name	Description
.definePoint(<option>)	Method for defining a pick sequence to define a pure position object definition.
Argument (Option)	Description
pnt	Derives an position at the derived positional.
Packet Members	Settings
.description	Defined by option.
.priority	0.
.remove	True.
.input
Return Array	Description
[1] position	Standard position object.

Method Name	Description
.defineLine(<option>)	Method for defining a pick sequence to define a line object definition.
Argument (Option)	Description
pntPnt	Defines a line between the two positional picks.
angle	Defines a line based on the first pick (line element), which angled by value supplied via the input form the line towards the second pick (positional). The third pick (positional) defines the start of the line definition.
derive	Defines a line derived from the picked element.
pntTan	Defines a line from the first pick (positional) to the nearest tangent point of the second pick (curve element).
tanTan	Defines a line to the nearest tangent points on the two curves picked.
bisect	Defines a line that bisect the two lines picked, line is based on the first line picked.
twoPlanes	Defines a line that is at the intersection of the two picked plane elements.
shortest	Defies a line that is between the two closest points of the graphical entities picked. Where the two items are parallel, then the line is from the first picked position onto the second. Where two items converge and the line is zero length, then an unset line is returned.
Packet Members	Settings
.description	Defined by option.
.priority	0.
.remove	True.
.input
Return Array	Description
[1] line	Standard line object.

Method Name	Description
.definePlane(<option>)	Method for defining a pick sequence to define a plane object definition.
Argument (Option)	Description
3pnt	Derives a plane passing through the three positional picks. The first two define the centre and the X-axes, the third defines the relative Y-axes.
Packet Members	Settings
.description	Defined by option.
.priority	0.
.remove	True.
.input
Return Array	Description
[1] plane	Standard plane object.

Method Name	Description
.defineMeasure(<option>)	Method for defining a pick sequence to derive a measurement.
Argument (Option)	Description
distance	Defines a line object that equates to the distance between the two positional picks.
shortest	Defines a line object that equates to the shortest distance between the to graphical entities picked.
angle	Defines an arc that represents the angle between the three positional picks. The first pick defines the point about which the angle is, the second and third, the points through which the start and end of the angle passes.
lineAngle	Defines a real that relates to the angle between the two linear items picked.
Packet Members	Settings
.description	Defined by option.
.priority	0.
.remove	True.
.input
Return Array	Description
[1] line (distance)	Standard line object.
[1] line (shortest)	Standard line object.
[1] arc (angle)	Standard arc object (radius is unit length of 1000mm).
[1] real (lineAngle)	Real.