Section Plane
- Last UpdatedAug 15, 2024
- 2 minute read
The Section Plane object provides an interface for interrogating and modifying a Section Plane in the 3D View in Draft. It can be used in conjunction with the PMLSectionPlaneManager PML Object. In order to add a PMLSectionPlane to the 3D View, the PMLSectionPlaneManager must be used.
Set-up Methods
|
Method |
Result |
Purpose |
|
sectionPlane (DBREF) |
constructor |
Creates the Section Plane Object with the given DBREF, which must represent a SPLA, PPLA or FPLA element. |
Display Methods
|
Name |
Result |
Purpose |
|
Redraw () |
No Result |
Redraw the plane in the 3D View. A plane is infinite in two directions, but is drawn with it's infinite edges clipped to the edges of the current drawlist. Therefore, if the plane is moved, or if the drawlist changes, the plane may need to be redrawn. |
|
Highlight () |
No Result |
Temporarily highlight the Section Plane in the 3D View. |
|
Show (BOOLEAN) |
No Result |
Show/hide a plane in the 3D View. |
|
setClipping (BOOLEAN, DBREF) |
No Result |
Set/unset the clipping status of the section plane within the VIEW. DBREF is the reference of the VIEW element |
|
switchClipside (DBREF) |
No Result |
Switch between standard and reverse for which side of the section plane the model will be clipped. DBREF is the reference of the VIEW element. |
|
showClipItems (BOOLEAN, DBREF) |
No Result |
Highlight the items in the 3d view that are in the clip list for this section plane. DBREF is the reference of the VIEW element. |
|
redefinePoints (DIRECTION) |
No Result |
Clear the points defining the section plane, and start a user interaction to redefine them. DIRECTION specifies the direction in which the lines between the points are to be extruded. |
|
Colour (REAL) |
No Result |
Set the colour of the Section Plane (Real must be a colour.code()). |
|
Translucency (REAL) |
No Result |
Set the translucency of the Section Plane. 99 = transparent, 1 = opaque |
Query Methods
|
Name |
Result |
Purpose |
|
isValid () |
BOOLEAN |
Checks if the section plane object is valid. |
|
queryDbref () |
DBREF |
Returns the actual database element. |
|
queryShow () |
BOOLEAN |
Get the show of the Section Plane. |
|
queryClip () |
BOOLEAN |
Get the clipped value of the Section Plane. |
|
queryType () |
STRING |
Get the types of the Section Plane. (SPLA, FPLA, PPLA) |
|
queryColour () |
INTEGER |
Get the color of the Section Plane. |
|
queryTranslucency () |
INTEGER |
Get the translucency of the Section Plane. |
Table 2: 108. Selection Plane Object Methods