Open CASCADE Technology 6.6.0
Public Member Functions | Protected Attributes | Friends
V3d_Plane Class Reference

Defines the services of Plane type objects. Only
the creation and editing of the functions is dealt
with here.
Warning: The representation of the clipping plane must be
calculated by the application by means of Graphic3d.
Editing of this representation must be coherent with
respect to the position of the plane.

#include <V3d_Plane.hxx>

Inheritance diagram for V3d_Plane:
Inheritance graph
[legend]

Public Member Functions

 V3d_Plane (const Quantity_Parameter A=0.0, const Quantity_Parameter B=0.0, const Quantity_Parameter C=1.0, const Quantity_Parameter D=0.0)
 Creates a clipping plane using the equation :
*X + *Y + *Z + <D> = 0.0
//! Warning! raises BadValue from V3d
if the norm of the plane is NULL.

void SetPlane (const Quantity_Parameter A, const Quantity_Parameter B, const Quantity_Parameter C, const Quantity_Parameter D)
 Modifies the plane equation.
//! Warning! raises BadValue from V3d
if the norm of the plane is NULL.
If the norm of the plane is NULL.

virtual void Display (const Handle< V3d_View > &aView, const Quantity_Color &aColor=Quantity_NOC_GRAY)
 Display the plane representation
in the choosen view.

void Erase ()
 Erase the plane representation.

void Plane (Quantity_Parameter &A, Quantity_Parameter &B, Quantity_Parameter &C, Quantity_Parameter &D) const
 Returns the parameters of the plane .

Standard_Boolean IsDisplayed () const
 Returns TRUE when the plane representation is displayed

Protected Attributes

Handle_Graphic3d_Structure MyGraphicStructure

Friends

void V3d_View::SetPlaneOn ()
 Activate all the clipping planes defined in
this view.
//! If No More Plane can be activated in MyView .

void V3d_View::SetPlaneOn (const Handle< V3d_Plane > &MyPlane)
 Activates the clipping plane in this view.
//! If No More Plane can be activated in MyView .

void V3d_View::SetPlaneOff ()
 Deactivate all clipping planes defined
in this view.

void V3d_View::SetPlaneOff (const Handle< V3d_Plane > &MyPlane)
 Desactivates the clipping plane defined
in this view.


Constructor & Destructor Documentation

V3d_Plane::V3d_Plane ( const Quantity_Parameter  A = 0.0,
const Quantity_Parameter  B = 0.0,
const Quantity_Parameter  C = 1.0,
const Quantity_Parameter  D = 0.0 
)

Member Function Documentation

virtual void V3d_Plane::Display ( const Handle< V3d_View > &  aView,
const Quantity_Color aColor = Quantity_NOC_GRAY 
) [virtual]
void V3d_Plane::Erase ( )
Standard_Boolean V3d_Plane::IsDisplayed ( ) const
void V3d_Plane::Plane ( Quantity_Parameter A,
Quantity_Parameter B,
Quantity_Parameter C,
Quantity_Parameter D 
) const
void V3d_Plane::SetPlane ( const Quantity_Parameter  A,
const Quantity_Parameter  B,
const Quantity_Parameter  C,
const Quantity_Parameter  D 
)

Friends And Related Function Documentation

void V3d_View::SetPlaneOff ( ) [friend]
void V3d_View::SetPlaneOff ( const Handle< V3d_Plane > &  MyPlane) [friend]
void V3d_View::SetPlaneOn ( ) [friend]
void V3d_View::SetPlaneOn ( const Handle< V3d_Plane > &  MyPlane) [friend]

Field Documentation

Handle_Graphic3d_Structure V3d_Plane::MyGraphicStructure [protected]

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