AVEVA™ Engineering

Published Interface

Save PDF

Published Interface

Save PDF

Last UpdatedNov 07, 2024
13 minute read

There are two main components to the pick packet object, these are the member and methods.

Members

The following are published member interface into the object, members not defined within this table are internal to the object and should never be set by the developer.

Name	Type	Action
.description	STRING	Description of the event packet.
.key	STRING	Single word identifier.
.prompt	STRING	Primary prompt (shown at the beginning of the prompt status line).
.picks	ARRAY	Picks types edgPickType defining the pick sequence.
.action	STRING	Action carried out after all the picks within the pick sequence have been completed.
.input	ARRAY	Contains information to be held local to the pick packet, which can be used during it execution.

Methods

There are several methods that can be used to define a standard pick packet, the following are the ones currently supported:

Name	Action
.stdGphWindow(<prompt>)	Standard graphical window pick (only screen position used).
.stdScreen(<prompt>)	Standard screen pick.
.stdView(<prompt>)	Standard screen pick.
.stdElement(<prompt>)	Standard element pick.
.stdAny(<prompt>)	Standard element pick.
.stdPpoint(<prompt>)	Standard ppoint pick.
.stdPline(<prompt>)	Standard pline pick.
.stdAid(<prompt>)	Standard aid element pick.
.stdGraphic(<prompt>)	Standard graphical pick.
.direction(<prompt>)	Standard derive direction pick.
.measureDistance()	Standard distance measure.
.measureAngle()	Standard angle measure between three point.
.measureLineAngle()	Standard angle measure between two lines.
.stdPosition (<prompt>)	Standard 3D single position pick.
.circle3pnts()	Circle through 3 points.
.circleDia3d()	Circle through 2 Positions (diameter defined) 3D.
.circleRad3D()	Circle define centre and radius + control point 3D.
.circleFixRad3D(<any>)	Circle centred of defined radius 3D.
.circleFixDia3D(<any>)	Circle centred of defined diameter 3D.
.circleDia2D(<any>)	Circle through 2 Positions (diameter defined) 2D.
.circleRad2D(<any>)	Circle define centre and radius + control point 2D.
.circleFixRad2D(<any>, <any>)	Circle define centre and radius + control point 2D.
.circleFixDia2D(<any>, <any>)	Circle centred of defined diameter 2D.
.circleFillet(<any>)	Fillet circle of defined radius.
.circleTan3Lines()	Circle tangential to 3 lines.
.circleTanTan(<any>)	Circle tangential to two other circles.
.circlePntTan()	Circle, centred and tangential to another circles.
.circleFRadPntTan(<any>)	Circle, centred and tangential to another circles of fixed radius.
.circleFRadPntPnt(<any>)	Circle going through two points + polar control point.
.circleDerive()	Derive a circle from a DB element.
.pointPnt()	Define working point in 3D space.
.linePntPnt()	Define a line.
.lineAngle(<any>)	Line offset by an angle from the picked line, towards the second pick.
.lineDerive()	Derive a line from a db element.
.linePntTan()	Line between point an tangent of arc.
.lineTanTan()	Line between tangent points of two arcs.
.lineBisect()	Line bisecting two other lines (smallest angle side).
.lineTwoPlanes()	Line at intersection of two planes.
.lineShortest()	Shortest Line between to picked items.
.plane3pnts()	Define a plane through 3 Positions.
.plane2pnts (<position>)	Define a plane through 3 Positions.
.planeDerive()	Derive a plane from a DB element.

Note:
Where pick packet definitions are supplied with arguments with a specific data type, then these values have to be supplied before the event packet is placed in the event system. However, where pick packets have an <any> argument type, the can be supplied as a pointer (expression) that evaluates into the correct data type when the action of the pick is evaluated.

The following are the standard available methods and their default settings that can be modified or used by the developer. Members not shown in the list, but which are available for the developer, should be left as defined by the method.

Method Name	Description
.stdGphWindow(<prompt>)	Standard graphical window pick.
Arguments	Description
<prompt>	Primary display prompt.
Picks Types	Description
[1] stdScreen	Pick a position on the graphics canvas (First point).
[2] stdScreen	Pick a position on the graphics canvas (Second point).
Pick Packet Members	Settings
.description	Standard Graphical window pick.
.key	StdGphWindow
.input
Return Array	Description
[1] ARC	Arc defining the plane of view and extremities of the pick.
Method Name	Description
.stdScreen(<prompt>)	Standard graphical canvas pick, used to derive position in the selected view.
Arguments	Description
<prompt>	Primary display prompt.
Picks Types	Description
[1] stdScreen	Pick a point on the graphical canvas.
Pick Packet Members	Settings
.description	Standard Screen Pick.
.key	StdScreen
.input
Return Array	Description
[1] POINTVECTOR	Contains direction of the view picked and the position on the view plane (normal to direction of view, through the center of view limits).
Method Name	Description
.stdView(<prompt>)	Standard view pick, used to determine graphic view picked.
Arguments	Description
<prompt>	Primary display prompt.
Picks Types	Description
[1] stdView	Pick view gadget.
Pick Packet Members	Settings
.description	Standard View Pick.
.key	stdView
.input
Return Array	Description
[1] GADGET	Pointer to view gadget picked.
Method Name	Description
.stdElement(<prompt>)	Standard element pick, picks database element form graphical view.
Arguments	Description
<prompt>	Primary display prompt.
Picks Types	Description
[1] stdElement	Pick database element.
Pick Packet Members	Settings
.description	Standard Element Pick.
.key	stdElement
.input
Return Array	Description
[1] edgPickData	Standard event pick return object.
Method Name	Description
.stdAny(<prompt>)	Pick any element displayed in the graphical view.
Arguments	Description
<prompt>	Primary display prompt.
Picks Types	Description
[1] stdAny	Pick any graphical element type.
Pick Packet Members	Settings
.description	Standard Any Pick
.key	stdAny
.input
Return Array	Description
[1] edgPickData	Standard event pick return object.
Method Name	Description
.stdPpoint(<prompt>)	Pick a ppoint of an element in the graphical view.
Arguments	Description
<prompt>	Primary display prompt.
Picks Types	Description
[1] stdPpoint	Pick a ppoint.
Pick Packet Members	Settings
.description	Standard Ppoint Pick.
.key	stdPpoint
.input
Return Array	Description
[1] edgPickData	Standard event pick return object.
Method Name	Description
.stdPline(<prompt>)	Pick a pline of an element in the graphical view.
Arguments	Description
<prompt>	Primary display prompt.
Picks Types	Description
[1] stdPline	Pick a structural pline.
Pick Packet Members	Settings
.description	Standard pline Pick.
.key	stdPline
.input
Return Array	Description
[1] edgPickData	Standard event pick return object.
Method Name	Description
.stdAid(<prompt>)	Pick a registered graphical aid element from the graphical view.
Arguments	Description
<prompt>	Primary display prompt.
Picks Types	Description
[1] stdAid	Pick graphical aid.
Pick Packet Members	Settings
.description	Standard Aid Element Pick.
.key	stdAid.
.input
Return Array	Description
[1] edgPickData	Standard event pick return object.
Method Name	Description
.stdGraphic(<prompt>)	Pick graphical component of any element in the graphical view, i.e. point, line or plane.
Arguments	Description
<prompt>	Primary display prompt.
Picks Types	Description
[1] stdGraphics	Pick graphical entity.
Pick Packet Members	Settings
.description	Standard Graphic Pick.
.key	stdGraphic
.input
Return Array	Description
[1] edgPickData	Standard event pick return object.
Method Name	Description
.direction (<prompt>)	Derive direction from graphical entity picked in the view.
Arguments	Description
<prompt>	Primary display prompt.
Picks Types	Description
[1] stdGraphics	Pick graphical entity.
Pick Packet Members	Settings
.description	Standard Derive Direction Pick.
.key	direction
.input
Return Array	Description
[1] DIRECTION	Standard direction object containing the direction of graphical item picked.
Method Name	Description
.measureDistance()	Standard linear measure of to derived positions.
Picks Types	Description
[1] stdPosition	Positional pick, start of measure.
[2] stdPosition	Positional pick, end of measure.
Pick Packet Members	Settings
.description	Standard Distance Measure.
.key	measureDistance
.prompt	Measure distance.
.input
Return Array	Description
[1] LINE	Standard line object, contains the start point and end point. To extract the distance, .length() is used on the element.
Method Name	Description
.measureAngle()	Standard measure of an angle between three position in space.
Picks Types	Description
[1] stdPosition	Positional pick, root of angle.
[2] stdPosition	Positional pick, first point.
[3] stdPosition	Positional pick, second pick.
Pick Packet Members	Settings
.description	Standard Angle Measure.
.key	measureAngle
.prompt	Measure angle.
.input
Return Array	Description
[1] ARC	Standard arc object, centered on the root of the angle. To extract the angle .angle() is used on the element.
Method Name	Description
.measureLineAngle()	Standard measure of an angle between two graphical line.
Picks Types	Description
[1] stdGraphics	Pick graphical line entity, first line.
[2] stdGraphics	Pick graphical line entity, second line.
Pick Packet Members	Settings
.description	Standard Line Angle Measure.
.key	measureLineAngle
.prompt	Measure angle between lines.
.input
Return Array	Description
[1] REAL	Angle between the two picked lines.
Method Name	Description
.stdPosition (<prompt>)	Standard derive position from graphical pick.
Arguments	Description
<prompt>	Primary display prompt.
Picks Types	Description
[1] stdPosition	Positional pick.
Pick Packet Members	Settings
.description	Standard single position Pick.
.key	stdPosition
.input
Return Array	Description
[1] edgPosition Data	Event picked position return object, contains all pick data and derived position from the pick.
Method Name	Description
.circle3Pnts()	Define a circle (arc) through point in 3D space.
Picks Types	Description
[1] stdPosition	Positional pick, first point (start of arc).
[2] stdPosition	Positional pick, second point (point on circumference).
[3] stdPosition	Positional pick, third point (end of arc).
Pick Packet Members	Settings
.description	Circle through 3 Points.
.key	circle3Pnts
.prompt	Circle (three points).
.input
Return Array	Description
[1] ARC	Standard arc object.
Method Name	Description
.circleDia3D()	Define a circle (arc) of diameter between two picks in a plane defined by a third.
Picks Types	Description
[1] stdPosition	Positional pick, first point (start of arc).
[2] stdPosition	Positional pick, second point (diameter).
[3] stdPosition	Positional pick, control point (Y).
Pick Packet Members	Settings
.description	Circle derive diameter.
.key	circleDia3D.
.prompt	Circle (derive diameter).
.input
Return Array	Description
[1] ARC	Standard arc object.
Method Name	Description
.circleRad3D()	Define a circle (arc) of radius between two picks in a plane defined by a third.
Picks Types	Description
[1] stdPosition	Positional pick, center.
[2] stdPosition	Positional pick, radius through point (X axes).
[3] stdPosition	Positional pick, control point (Y).
Pick Packet Members	Settings
.description	Circle centered, derived radius.
.key	circleRad3D
.prompt	Circle (derive radius).
.input
Return Array	Description
[1] ARC	Standard arc object.
Method Name	Description
.circleFixRad3D (<any>)	Define a circle (arc) with supplied radius centered on the first point, orientated by the second and third points.
Arguments	Description
<any>	Any data type that must equate to a real value (radius).
Picks Types	Description
[1] stdPosition	Positional pick, center.
[2] stdPosition	Positional pick, first control point (X).
[3] stdPosition	Positional pick, second control point (Y).
Pick Packet Members	Settings
.description	Circle Center, defined radius.
.key	circleFixRad3D
.prompt	Circle (defined radius).
.input
Return Array	Description
[1] ARC	Standard arc object.
Method Name	Description
.circleFixDia3D(<any>)	Define a circle (arc) with supplied diameter centered on the first point, orientated by the second and third points.
Arguments	Description
<any>	Any data type that must equate to a real value (diameter).
Picks Types	Description
[1] stdPosition	Positional pick, center.
[2] stdPosition	Positional pick, first control point (X).
[3] stdPosition	Positional pick, second control point (Y).
Pick Packet Members	Settings
.description	Circle Center, defined diameter.
.key	circleFixDia3D
.prompt	Circle (defined diameter).
.input
Return Array	Description
[1] ARC	Standard arc object.
Method Name	Description
.circleDia2D(<any>)	Define a circle (arc) with diameter between the two picked positions, mapped onto the passed plane.
Arguments	Description
<any>	Any data type that must equate to a plane object.
Picks Types	Description
[1] stdPosition	Positional pick, first point (start & X axes).
[2] stdPosition	Positional pick, second point (diameter).
Pick Packet Members	Settings
.description	Circle derived diameter.
.key	circleDia2D
.prompt	Circle (derived diameter).
.input
Return Array	Description
[1] ARC	Standard arc object.
Method Name	Description
.circleRad2D(<any>)	Derive a circle (arc) with radius between the two picked positions, mapped onto the passed plane.
Arguments	Description
<any>	Any data type that must equate to a plane object.
Picks Types	Description
[1] stdPosition	Positional pick, center.
[2] stdPosition	Positional pick, radius through point (X axes).
Pick Packet Members	Settings
.description	Circle centered, derived radius.
.key	circleRad2D
.prompt	Circle (derived radius).
.input
Return Array	Description
[1] ARC	Standard arc object.
Method Name	Description
.circleFixRad2D(<any>,<any>)	Derive a circle (arc) with specified radius centered on the picked positions, mapped onto the passed plane.
Arguments	Description
<any>	Any data type that must equate to a plane object.
<any>	Any data type that must equate to a real (radius).
Picks Types	Description
[1] stdPosition	Positional pick, center.
Pick Packet Members	Settings
.description	Circle Center, defined radius.
.key	circleFixRad2D
.prompt	Circle (defined radius).
.input
Return Array	Description
[1] ARC	Standard arc object.
Method Name	Description
.circleFixDia2D(<any>,<any>)	Derive a circle (arc) with specified diameter centered on the picked positions, mapped onto the passed plane.
Arguments	Description
<any>	Any data type that must equate to a plane object.
<any>	Any data type that must equate to a real (diameter).
Picks Types	Description
[1] stdPosition	Positional pick, center.
Pick Packet Members	Settings
.description	Circle Center, defined diameter.
.key	circleFixDia2D
.prompt	Circle (defined diameter).
.input
Return Array	Description
[1] ARC	Standard arc object.
Method Name	Description
.circleFillet(<any>)	Derive a circle (arc) of supplied radius between two picked lines.
Arguments	Description
<any>	Any data type that must equate to a real (diameter).
Picks Types	Description
[1] positionLinear	Pick linear items and position on it, first line.
[2] positionLinear	Pick linear items and position on it, second line
Pick Packet Members	Settings
.description	Fillet Circle of defined radius.
.key	circleFillet
.prompt	Circle (Fillet).
.input
Return Array	Description
[1] ARC	Standard arc object.
Method Name	Description
.circleTan3Lines()	Derive a circle (arc) which is tangential to the three picked graphical lines.
Picks Types	Description
[1] positionLinear	Pick linear items and position on it, first line.
[2] positionLinear	Pick linear items and position on it, second line.
[3] positionLinear	Pick linear items and position on it, third line.
Pick Packet Members	Settings
.description	Circle tangential to 3 lines.
.key	circleTan3Lines
.prompt	Circle (Tan. To 3 lines).
.input
Return Array	Description
[1] ARC	Standard arc object.
Method Name	Description
.circleTanTan(<any>)	Derive a circle (arc) of supplied radius which is tangential to the two circular elements picked, with center towards the third positional pick.
Arguments	Description
<any>	Any data type that must equate to a real (radius).
Picks Types	Description
[1] positionArc	Pick arc items and position on it, first circle.
[2] positionArc	Pick arc items and position on it, second circle.
[3] stdPosition	Position pick, center side.
Pick Packet Members	Settings
.description	Circle tangential to two other circles.
.key	circleTanTan
.prompt	Circle (tangential).
.input
Return Array	Description
[1] ARC	Standard arc object.
Method Name	Description
.circlePntTan()	Derive a circle (arc) with radius from first positional pick to nearest tangent on picked circular element.
Picks Types	Description
[1] stdPosition	Position pick, center.
[2] positionArc	Pick arc items and position on it, circle.
Pick Packet Members	Settings
.description	Circle, centered and tangential to another circle.
.key	circlePntTan
.prompt	Circle (point - tangent).
.input
Return Array	Description
[1] ARC	Standard arc object.
Method Name	Description
.circleFRadPntTan(<any>)	Derive a circle (arc) of specified radius which lies on the line from the first positional pick to the center of arc of the second pick.
Arguments	Description
<any>	Any data type that must equate to a real (radius).
Picks Types	Description
[1] stdPosition	Position pick, control point.
[2] positionArc	Pick arc items and position on it, circle.
Pick Packet Members	Settings
.description	Circle, centered and tangential to another circle of fixed radius.
.key	circleFRadPntTan
.prompt	Circle (point - tangent).
.input
Return Array	Description
[1] ARC	Standard arc object.
Method Name	Description
.circleFRadPntPnt(<any>)	Derive a circle (arc) of specified radius that passes through the first two positional picks, the third defines the direction of the "bulge".
Arguments	Description
<any>	Any data type that must equate to a real (radius).
Picks Types	Description
[1] stdPosition	Position pick, start point.
[2] stdPosition	Position pick, end point.
[3] stdPosition	Position pick, polar control point.
Pick Packet Members	Settings
.description	Circle, through 2 points + polar control point.
.key	circleFRadPntPnt
.prompt	Circle (through 2 points).
.input
Return Array	Description
[1] ARC	Standard arc object.
Method Name	Description
.circleDerive()	Derive a circle (arc) from the picked database element.
Picks Types	Description
[1] dbCircle	Pick database element that can be interpreted as an arc.
Pick Packet Members	Settings
.description	Derive a Circle from a db Element.
.key	circleDerive
.prompt	Circle (derived).
.input
Return Array	Description
[1] ARC	Standard arc object.
Method Name	Description
.pointPnt()	Derive a point in space.
Picks Types	Description
[1] stdPosition	Position pick.
Pick Packet Members	Settings
.description	Define Working Point.
.key	pointPnt
.prompt	Working Point (position).
.input
Return Array	Description
[1] POSITION	Standard position object.
Method Name	Description
.linePntPnt()	Derive a line between two points in space.
Picks Types	Description
[1] stdPosition	Position pick, start.
[2] stdPosition	Position pick, end.
Pick Packet Members	Settings
.description	Line between two points.
.key	linePntPnt
.prompt	Line.
.input
Return Array	Description
[1] LINE	Standard line object.
Method Name	Description
.lineAngle(<any>)	Derive a line offset by the supplied angle (towards the first positional pick) starting at the second positional pick.
Arguments	Description
<any>	Any data type that must equate to a real (angle).
Picks Types	Description
[1] positionLinear	Pick linear items and position on it, line to be copied.
[2] stdPosition	Position pick, position angle is towards (wrt to original).
[2] stdPosition	Position pick, start position (copied line).
Pick Packet Members	Settings
.description	Line offset by angle from another.
.key	lineAngle
.prompt	Line (offset angle).
.input
Return Array	Description
[1] LINE	Standard line object.
Method Name	Description
.lineDerive()	Derive a line from the picked database element.
Picks Types	Description
[1] dbLine	Pick database element that can be interpreted as an line.
Pick Packet Members	Settings
.description	Derive a line from a db element.
.key	lineDerive
.prompt	Line (derive).
.input
Return Array	Description
[1] LINE	Standard line object.
Method Name	Description
.linePntTan()	Derive a line between a point and the nearest tangent point on a picked arc.
Picks Types	Description
[1] stdPosition	Position pick, start.
[2] positionArc	Pick arc items and position on it, circle/arc.
Pick Packet Members	Settings
.description	Line between point and tangent of arc.
.key	linePntTan
.prompt	Line (point - tangent).
.input
Return Array	Description
[1] LINE	Standard line object.
Method Name	Description
.lineTanTan()	Derive a line between the nearest tangent points on the arcs pick.
Picks Types	Description
[1] positionArc	Pick arc items and position on it, first circle/arc.
[2] positionArc	Pick arc items and position on it, second circle/arc.
Pick Packet Members	Settings
.description	Line between tangents of two arcs.
.key	lineTanTan
.prompt	Line (tangent - tangent).
.input
Return Array	Description
[1] LINE	Standard line object.
Method Name	Description
.lineBisect()	Derive a line that bisects the two lines picked.
Picks Types	Description
[1] positionLinear	Pick linear items and position on it, first line.
[2] positionLinear	Pick linear items and position on it, second line.
Pick Packet Members	Settings
.description	Line bisection two lines.
.key	lineBisect
.prompt	Line (bisect).
.input
Return Array	Description
[1] LINE	Standard line object.
Method Name	Description
.lineTwoPlanes()	Derive a line at the intersection of the two picked plane.
Picks Types	Description
[1] positionPlane	Pick planar items and position on it, first plane.
[2] positionPlane	Pick planar items and position on it, second plane.
Pick Packet Members	Settings
.description	Line at intersection of 2 planes.
.key	lineTwoPlanes
.prompt	Line (2 planes).
.input
Return Array	Description
[1] LINE	Standard line object.
Method Name	Description
.lineShortest()	Derive the shortest line between two graphical entities, parallel items will start at the position of the first pick.
Picks Types	Description
[1] stdGraphics	Pick graphical entity, from.
[2] stdGraphics	Pick graphical entity, to.
Pick Packet Members	Settings
.description	Standard Parallel Distance Measure.
.key	lineShortest
.prompt	Measure distance.
.input
Return Array	Description
[1] LINE	Standard line object.
Method Name	Description
.plane3Pnts()	Derive a plane that passes through the three positions picked.
Picks Types	Description
[1] stdPosition	Position pick, first point (center of the plane).
[2] stdPosition	Position pick, second point (X axes).
[3] stdPosition	Position pick, third point (Y axes).
Pick Packet Members	Settings
.description	Plane through 3 Positions.
.key	plane3Pnts
.prompt	Plane (three points).
.input
Return Array	Description
[1] PLANE	Standard plane object.
Method Name	Description
.plane2Pnts (<position>)	Derive a plane that is centered on the passed position and orientated to the two positional picks.
Arguments	Description
<position>	Position of plane origin.
Picks Types	Description
[1] stdPosition	Position pick, X through point.
[2] stdPosition	Position pick, Y through point.
Pick Packet Members	Settings
.description	Plane through 2 Positions (supplied position is center).
.key	plane2Pnts
.prompt	Plane (two points).
.input
Return Array	Description
[1] PLANE	Standard plane object.
Method Name	Description
.planeDerive()	Derive a plane from the picked database element.
Picks Types	Description
[1] dbPlane	Pick database element that can be interpreted as an plane.
Pick Packet Members	Settings
.description	Derive a plane from a db element.
.key	derivePlane
.prompt	Derive plane.
.input
Return Array	Description
[1] PLANE	Standard plane object.

Note:
When defining pick packets using the above methods, the method should be applied to the object before any of the other members are set, as the methods will overwrite several of the pick packet members.

AVEVA™ Engineering

Published Interface

Table of Contents

Published Interface

Related Links