Open CASCADE Technology 6.6.0
Public Member Functions
AIS_Plane Class Reference

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

#include <AIS_Plane.hxx>

Inheritance diagram for AIS_Plane:
Inheritance graph
[legend]

Public Member Functions

 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.

 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.

 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.

 AIS_Plane (const Handle< Geom_Axis2Placement > &aComponent, const AIS_TypeOfPlane aPlaneType, const Standard_Boolean aCurrentMode=Standard_False)
void SetSize (const Standard_Real aValue)
 Same value for x and y directions

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.

void UnsetSize ()
Standard_Boolean Size (Standard_Real &X, Standard_Real &Y) const
Standard_Boolean HasOwnSize () const
virtual 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:

virtual AIS_KindOfInteractive Type () const
 Returns the kind of Interactive Object:

const Handle_Geom_Plane & Component ()
 Returns the component specified in SetComponent.

void SetComponent (const Handle< Geom_Plane > &aComponent)
 Creates an instance of the plane aComponent.

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

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_PntCenter () 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).

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:

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_Boolean AcceptDisplayMode (const Standard_Integer aMode) const
 Returns true if the display mode selected, aMode, is valid for planes.

virtual void SetContext (const Handle< AIS_InteractiveContext > &aCtx)
 connection to <aCtx> default drawer implies a recomputation of Frame values.

virtual 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 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.

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)

void SetColor (const Quantity_Color &aColor)
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.


Constructor & Destructor Documentation

AIS_Plane::AIS_Plane ( const Handle< Geom_Plane > &  aComponent,
const Standard_Boolean  aCurrentMode = Standard_False 
)
AIS_Plane::AIS_Plane ( const Handle< Geom_Plane > &  aComponent,
const gp_Pnt aCenter,
const Standard_Boolean  aCurrentMode = Standard_False 
)
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 
)
AIS_Plane::AIS_Plane ( const Handle< Geom_Axis2Placement > &  aComponent,
const AIS_TypeOfPlane  aPlaneType,
const Standard_Boolean  aCurrentMode = Standard_False 
)

Member Function Documentation

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

Reimplemented from AIS_InteractiveObject.

Handle_Geom_Axis2Placement AIS_Plane::Axis2Placement ( )
const gp_Pnt& AIS_Plane::Center ( ) const
const Handle_Geom_Plane& AIS_Plane::Component ( )
virtual void AIS_Plane::Compute ( const Handle< Prs3d_Projector > &  aProjector,
const Handle< Geom_Transformation > &  aTrsf,
const Handle< Prs3d_Presentation > &  aPresentation 
) [virtual]

Reimplemented from PrsMgr_PresentableObject.

virtual void AIS_Plane::ComputeSelection ( const Handle< SelectMgr_Selection > &  aSelection,
const Standard_Integer  aMode 
) [virtual]
Standard_Boolean AIS_Plane::CurrentMode ( )
Standard_Boolean AIS_Plane::HasOwnSize ( ) const
Standard_Boolean AIS_Plane::IsXYZPlane ( )
Standard_Boolean AIS_Plane::PlaneAttributes ( Handle< Geom_Plane > &  aComponent,
gp_Pnt aCenter,
gp_Pnt aPmin,
gp_Pnt aPmax 
)
void AIS_Plane::SetAxis2Placement ( const Handle< Geom_Axis2Placement > &  aComponent,
const AIS_TypeOfPlane  aPlaneType 
)
  • AIS_ TOPL_Unknown
  • AIS_ TOPL_XYPlane
  • AIS_ TOPL_XZPlane
  • AIS_ TOPL_YZPlane}.
void AIS_Plane::SetCenter ( const gp_Pnt aCenter)
void AIS_Plane::SetColor ( const Quantity_NameOfColor  aColor) [virtual]

Reimplemented from AIS_InteractiveObject.

void AIS_Plane::SetColor ( const Quantity_Color aColor) [virtual]

Reimplemented from AIS_InteractiveObject.

void AIS_Plane::SetComponent ( const Handle< Geom_Plane > &  aComponent)
virtual void AIS_Plane::SetContext ( const Handle< AIS_InteractiveContext > &  aCtx) [virtual]

Reimplemented from AIS_InteractiveObject.

void AIS_Plane::SetCurrentMode ( const Standard_Boolean  aCurrentMode)
void AIS_Plane::SetPlaneAttributes ( const Handle< Geom_Plane > &  aComponent,
const gp_Pnt aCenter,
const gp_Pnt aPmin,
const gp_Pnt aPmax 
)
void AIS_Plane::SetSize ( const Standard_Real  Xval,
const Standard_Real  YVal 
)
void AIS_Plane::SetSize ( const Standard_Real  aValue)
virtual Standard_Integer AIS_Plane::Signature ( ) const [virtual]
  • Point signature 1
  • Axis signature 2
  • Trihedron signature 3
  • PlaneTrihedron signature 4
  • Line signature 5
  • Circle signature 6
  • Plane signature 7.

Reimplemented from AIS_InteractiveObject.

Standard_Boolean AIS_Plane::Size ( Standard_Real X,
Standard_Real Y 
) const
virtual AIS_KindOfInteractive AIS_Plane::Type ( ) const [virtual]
  • 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.

Reimplemented from AIS_InteractiveObject.

AIS_TypeOfPlane AIS_Plane::TypeOfPlane ( )
void AIS_Plane::UnsetColor ( ) [virtual]

Reimplemented from AIS_InteractiveObject.

void AIS_Plane::UnsetSize ( )

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines