# Visualization
TKV3d
AIS

# AIS_Plane Class Reference

Constructs plane datums to be used in construction of
composite shapes.
.

`#include <AIS_Plane.hxx>`

Inheritance diagram for AIS_Plane:

[legend]

## Public Member Functions

Standard_EXPORT | AIS_Plane (const Handle(Geom_Plane)&aComponent, const Standard_Boolean aCurrentMode=Standard_False)
| initializes the plane aComponent. If the mode aCurrentMode equals true, the drawing tool, "Drawer" is not initialized.
Standard_EXPORT | AIS_Plane (const Handle(Geom_Plane)&aComponent, const gp_Pnt &aCenter, const Standard_Boolean aCurrentMode=Standard_False)
| initializes the plane aComponent and the point aCenter. If the mode aCurrentMode equals true, the drawing tool, "Drawer" is not initialized. aCurrentMode equals true, the drawing tool, "Drawer" is not initialized.
Standard_EXPORT | AIS_Plane (const Handle(Geom_Plane)&aComponent, const gp_Pnt &aCenter, const gp_Pnt &aPmin, const gp_Pnt &aPmax, const Standard_Boolean aCurrentMode=Standard_False)
| initializes the plane aComponent, the point aCenter, and the minimum and maximum points, aPmin and aPmax. If the mode aCurrentMode equals true, the drawing tool, "Drawer" is not initialized.
Standard_EXPORT | AIS_Plane (const Handle(Geom_Axis2Placement)&aComponent, const AIS_TypeOfPlane aPlaneType, const Standard_Boolean aCurrentMode=Standard_False)
Standard_EXPORT void | SetSize (const Standard_Real aValue)
| Same value for x and y directions .
Standard_EXPORT void | SetSize (const Standard_Real Xval, const Standard_Real YVal)
| Sets the size defined by the length along the X axis XVal and the length along the Y axis YVal. .
Standard_EXPORT void | UnsetSize ()
Standard_EXPORT Standard_Boolean | Size (Standard_Real &X, Standard_Real &Y) const
Standard_Boolean | HasOwnSize () const
virtual Standard_EXPORT Standard_Integer | Signature () const

Specifies additional characteristics of Interactive
Objects. A signature is, in fact, an index with integer
values assigned different properties.
This method is frequently used in conjuction with
Type to give a particular type and signature to an
Interactive Object. By default, the Interactive Object
has a None type and a signature of 0. Among the
datums, this signature is attributed to the shape
The remaining datums have the following default signatures:
- Point signature 1
- Axis signature 2
- Trihedron signature 3
- PlaneTrihedron signature 4
- Line signature 5
- Circle signature 6
- Plane signature 7.
.

virtual Standard_EXPORT AIS_KindOfInteractive | Type () const
| Returns the kind of Interactive Object: - None - Datum - Relation - Object By default, the interactive object has a None type. Because specific shapes entail different behavior according to their sub-shapes, you may need to create a Local Context. This will allow you to specify the additional characteristics which you need to handle these shapes. .
const Handle_Geom_Plane & | Component ()
| Returns the component specified in SetComponent. .
Standard_EXPORT void | SetComponent (const Handle(Geom_Plane)&aComponent)
| Creates an instance of the plane aComponent. .
Standard_EXPORT Standard_Boolean | PlaneAttributes (Handle(Geom_Plane)&aComponent, gp_Pnt &aCenter, gp_Pnt &aPmin, gp_Pnt &aPmax)
| Returns the settings for the selected plane aComponent, provided in SetPlaneAttributes. These include the points aCenter, aPmin, and aPmax .
Standard_EXPORT void | SetPlaneAttributes (const Handle(Geom_Plane)&aComponent, const gp_Pnt &aCenter, const gp_Pnt &aPmin, const gp_Pnt &aPmax)
| Allows you to provide settings other than default ones for the selected plane. These include: center point aCenter, maximum aPmax and minimum aPmin. .
const gp_Pnt & | Center () const
| Returns the coordinates of the center point. .
void | SetCenter (const gp_Pnt &aCenter)
| Provides settings for the center aCenter other than (0, 0, 0). .
Standard_EXPORT void | SetAxis2Placement (const Handle(Geom_Axis2Placement)&aComponent, const AIS_TypeOfPlane aPlaneType)
| Allows you to provide settings for the position and direction of one of the plane's axes, aComponent, in 3D space. The coordinate system used is right-handed, and the type of plane aPlaneType is one of: - AIS_ TOPL_Unknown - AIS_ TOPL_XYPlane - AIS_ TOPL_XZPlane - AIS_ TOPL_YZPlane}. .
Standard_EXPORT Handle_Geom_Axis2Placement | Axis2Placement ()
| Returns the position of the plane's axis2 system identifying the x, y, or z axis and giving the plane a direction in 3D space. An axis2 system is a right-handed coordinate system. .
AIS_TypeOfPlane | TypeOfPlane ()
| Returns the type of plane - xy, yz, xz or unknown. .
Standard_Boolean | IsXYZPlane ()
| Returns the type of plane - xy, yz, or xz. .
Standard_Boolean | CurrentMode ()
| Returns the non-default current display mode set by SetCurrentMode. .
void | SetCurrentMode (const Standard_Boolean aCurrentMode)
| Allows you to provide settings for a non-default current display mode. .
virtual Standard_EXPORT Standard_Boolean | AcceptDisplayMode (const Standard_Integer aMode) const
| Returns true if the display mode selected, aMode, is valid for planes. .
virtual Standard_EXPORT void | SetContext (const Handle(AIS_InteractiveContext)&aCtx)
| connection to <actx> default drawer implies a recomputation of Frame values.
virtual Standard_EXPORT void | Compute (const Handle(Prs3d_Projector)&aProjector, const Handle(Geom_Transformation)&aTrsf, const Handle(Prs3d_Presentation)&aPresentation)
| computes the presentation according to a point of view given by <aprojector>. To be Used when the associated degenerated Presentations have been transformed by <atrsf> which is not a Pure Translation. The HLR Prs can't be deducted automatically WARNING :<atrsf> must be applied to the object to display before computation !!!
virtual Standard_EXPORT void | ComputeSelection (const Handle(SelectMgr_Selection)&aSelection, const Standard_Integer aMode)

Recovers and calculates any sensitive primitive,
aSelection, available in Shape mode, specified by
aMode. As a rule, these are sensitive faces.
This method is defined as virtual. This enables you to
implement it in the creation of a new class of AIS
Interactive Object. You need to do this and in so
doing, redefine this method, if you create a class
which enriches the list of signatures and types.
.

Standard_EXPORT void | SetColor (const Quantity_NameOfColor aColor)
| only the interactive obj knowns which Drawer attribute is affected by the color (ex: for a wire, it's the wireaspect field of the drawer, but for a vertex, only the point aspect field is affected by the color) WARNING : Do not forget to set the corresponding fields here (hasOwnColor and myOwnColor)
Standard_EXPORT void | SetColor (const Quantity_Color &aColor)
Standard_EXPORT void | UnsetColor ()
| Removes color settings. Only the Interactive Object knows which Drawer attribute is affected by the color setting. For a wire, for example, wire aspect is the attribute affected. For a vertex, however, only point aspect is affected by the color setting. .
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const

## Private Member Functions

virtual Standard_EXPORT void | Compute (const Handle(PrsMgr_PresentationManager3d)&aPresentationManager, const Handle(Prs3d_Presentation)&aPresentation, const Standard_Integer aMode=0)
| Calculates the 3D view aPresentation and its updates. The latter are managed by aPresentationManager. aPresentableObject has the display mode aMode; this has the default value of 0, that is, the wireframe display mode. .
virtual Standard_EXPORT void | Compute (const Handle(Prs3d_Projector)&aProjector, const Handle(Prs3d_Presentation)&aPresentation)

Calculates the 3D view aPresentation and its
updates. The latter are managed by
aPresentationManager. Each of the views in the
viewer and every modification such as rotation, for
example, entails recalculation.
It must be redefined to implement hidden line removal
for the object. The user never calls this method
himself. This is done via the InteractiveContext object
and is dependent on the point of view from which the
object is displayed.
.

virtual Standard_EXPORT void | Compute (const Handle(PrsMgr_PresentationManager2d)&aPresentationManager, const Handle(Graphic2d_GraphicObject)&aPresentation, const Standard_Integer aMode=0)
| Calculates the 2D view aPresentation and its updates. The latter are managed by aPresentationManager. aPresentableObject has the display mode aMode; this has the default value of 0, that is, the wireframe display mode. Note that this syntax is not used in AIS as that package only concerns 3D display. .
Standard_EXPORT void | ComputeFrame ()
Standard_EXPORT void | ComputeFields ()
Standard_EXPORT void | InitDrawerAttributes ()

## Private Attributes

Handle_Geom_Plane | myComponent
Handle_Geom_Axis2Placement | myAx2
gp_Pnt | myCenter
gp_Pnt | myPmin
gp_Pnt | myPmax
Standard_Boolean | myCurrentMode
Standard_Boolean | myAutomaticPosition
AIS_TypeOfPlane | myTypeOfPlane
Standard_Boolean | myIsXYZPlane
Standard_Boolean | myHasOwnSize

## Constructor & Destructor Documentation

Standard_EXPORT AIS_Plane::AIS_Plane | ( | const Handle(Geom_Plane)& | aComponent,
|  | const Standard_Boolean | aCurrentMode = `Standard_False`
| ) |

Standard_EXPORT AIS_Plane::AIS_Plane | ( | const Handle(Geom_Plane)& | aComponent,
|  | const gp_Pnt & | aCenter,
|  | const Standard_Boolean | aCurrentMode = `Standard_False`
| ) |

Standard_EXPORT AIS_Plane::AIS_Plane | ( | const Handle(Geom_Plane)& | aComponent,
|  | const gp_Pnt & | aCenter,
|  | const gp_Pnt & | aPmin,
|  | const gp_Pnt & | aPmax,
|  | const Standard_Boolean | aCurrentMode = `Standard_False`
| ) |

Standard_EXPORT AIS_Plane::AIS_Plane | ( | const Handle(Geom_Axis2Placement)& | aComponent,
|  | const AIS_TypeOfPlane | aPlaneType,
|  | const Standard_Boolean | aCurrentMode = `Standard_False`
| ) |

## Member Function Documentation

virtual Standard_EXPORT Standard_Boolean AIS_Plane::AcceptDisplayMode | ( | const Standard_Integer | aMode | ) | const`[virtual]`

| Reimplemented from AIS_InteractiveObject.

Standard_EXPORT Handle_Geom_Axis2Placement AIS_Plane::Axis2Placement | ( |  | ) |

const gp_Pnt & AIS_Plane::Center | ( |  | ) | const`[inline]`

const Handle_Geom_Plane& AIS_Plane::Component | ( |  | ) |

virtual Standard_EXPORT void AIS_Plane::Compute | ( | const Handle(PrsMgr_PresentationManager2d)& | aPresentationManager,
|  | const Handle(Graphic2d_GraphicObject)& | aPresentation,
|  | const Standard_Integer | aMode = `0`
| ) | `[private, virtual]`

| Reimplemented from PrsMgr_PresentableObject.

virtual Standard_EXPORT void AIS_Plane::Compute | ( | const Handle(Prs3d_Projector)& | aProjector,
|  | const Handle(Prs3d_Presentation)& | aPresentation
| ) | `[private, virtual]`

| Reimplemented from PrsMgr_PresentableObject.

virtual Standard_EXPORT void AIS_Plane::Compute | ( | const Handle(PrsMgr_PresentationManager3d)& | aPresentationManager,
|  | const Handle(Prs3d_Presentation)& | aPresentation,
|  | const Standard_Integer | aMode = `0`
| ) | `[private, virtual]`

| Reimplemented from PrsMgr_PresentableObject.

virtual Standard_EXPORT void AIS_Plane::Compute | ( | const Handle(Prs3d_Projector)& | aProjector,
|  | const Handle(Geom_Transformation)& | aTrsf,
|  | const Handle(Prs3d_Presentation)& | aPresentation
| ) | `[virtual]`

| Reimplemented from PrsMgr_PresentableObject.

Standard_EXPORT void AIS_Plane::ComputeFields | ( |  | ) | `[private]`

Standard_EXPORT void AIS_Plane::ComputeFrame | ( |  | ) | `[private]`

virtual Standard_EXPORT void AIS_Plane::ComputeSelection | ( | const Handle(SelectMgr_Selection)& | aSelection,
|  | const Standard_Integer | aMode
| ) | `[virtual]`

| Implements SelectMgr_SelectableObject.

Standard_Boolean AIS_Plane::CurrentMode | ( |  | ) | `[inline]`

Standard_EXPORT const AIS_Plane::Handle | ( | Standard_Type |  | ) | const

| Reimplemented from AIS_InteractiveObject.

Standard_Boolean AIS_Plane::HasOwnSize | ( |  | ) | const`[inline]`

Standard_EXPORT void AIS_Plane::InitDrawerAttributes | ( |  | ) | `[private]`

Standard_Boolean AIS_Plane::IsXYZPlane | ( |  | ) | `[inline]`

Standard_EXPORT Standard_Boolean AIS_Plane::PlaneAttributes | ( | Handle(Geom_Plane)& | aComponent,
|  | gp_Pnt & | aCenter,
|  | gp_Pnt & | aPmin,
|  | gp_Pnt & | aPmax
| ) |

Standard_EXPORT void AIS_Plane::SetAxis2Placement | ( | const Handle(Geom_Axis2Placement)& | aComponent,
|  | const AIS_TypeOfPlane | aPlaneType
| ) |

void AIS_Plane::SetCenter | ( | const gp_Pnt & | aCenter | ) | `[inline]`

Standard_EXPORT void AIS_Plane::SetColor | ( | const Quantity_Color & | aColor | ) | `[virtual]`

| Reimplemented from AIS_InteractiveObject.

Standard_EXPORT void AIS_Plane::SetColor | ( | const Quantity_NameOfColor | aColor | ) | `[virtual]`

| Reimplemented from AIS_InteractiveObject.

Standard_EXPORT void AIS_Plane::SetComponent | ( | const Handle(Geom_Plane)& | aComponent | ) |

virtual Standard_EXPORT void AIS_Plane::SetContext | ( | const Handle(AIS_InteractiveContext)& | aCtx | ) | `[virtual]`

| Reimplemented from AIS_InteractiveObject.

void AIS_Plane::SetCurrentMode | ( | const Standard_Boolean | aCurrentMode | ) | `[inline]`

Standard_EXPORT void AIS_Plane::SetPlaneAttributes | ( | const Handle(Geom_Plane)& | aComponent,
|  | const gp_Pnt & | aCenter,
|  | const gp_Pnt & | aPmin,
|  | const gp_Pnt & | aPmax
| ) |

Standard_EXPORT void AIS_Plane::SetSize | ( | const Standard_Real | Xval,
|  | const Standard_Real | YVal
| ) |

Standard_EXPORT void AIS_Plane::SetSize | ( | const Standard_Real | aValue | ) |

virtual Standard_EXPORT Standard_Integer AIS_Plane::Signature | ( |  | ) | const`[virtual]`

| Reimplemented from AIS_InteractiveObject.

Standard_EXPORT Standard_Boolean AIS_Plane::Size | ( | Standard_Real & | X,
|  | Standard_Real & | Y
| ) | const

virtual Standard_EXPORT AIS_KindOfInteractive AIS_Plane::Type | ( |  | ) | const`[virtual]`

| Reimplemented from AIS_InteractiveObject.

AIS_TypeOfPlane AIS_Plane::TypeOfPlane | ( |  | ) | `[inline]`

Standard_EXPORT void AIS_Plane::UnsetColor | ( |  | ) | `[virtual]`

| Reimplemented from AIS_InteractiveObject.

Standard_EXPORT void AIS_Plane::UnsetSize | ( |  | ) |

## Field Documentation

Standard_Boolean AIS_Plane::myAutomaticPosition `[private]`

Handle_Geom_Axis2Placement AIS_Plane::myAx2 `[private]`

gp_Pnt AIS_Plane::myCenter `[private]`

Handle_Geom_Plane AIS_Plane::myComponent `[private]`

Standard_Boolean AIS_Plane::myCurrentMode `[private]`

Standard_Boolean AIS_Plane::myHasOwnSize `[private]`

Standard_Boolean AIS_Plane::myIsXYZPlane `[private]`

gp_Pnt AIS_Plane::myPmax `[private]`

gp_Pnt AIS_Plane::myPmin `[private]`

AIS_TypeOfPlane AIS_Plane::myTypeOfPlane `[private]`

The documentation for this class was generated from the following files:

- AIS_Plane.hxx
- AIS_Plane.lxx