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

Obsolete clip plane presentation class. Ported on new core of Graphic3d_ClipPlane approach. Please access Graphic3d_ClipPlane via ClipPlane() method to use it for standard clipping workflow. Example of use: More...

#include <V3d_Plane.hxx>

Inheritance diagram for V3d_Plane:
Inheritance graph
[legend]

Public Member Functions

 V3d_Plane (const Quantity_Parameter theA=0.0, const Quantity_Parameter theB=0.0, const Quantity_Parameter theC=1.0, const Quantity_Parameter theD=0.0)
 Creates a clipping plane from plane coefficients. More...
 
void SetPlane (const Quantity_Parameter theA, const Quantity_Parameter theB, const Quantity_Parameter theC, const Quantity_Parameter theD)
 Change plane equation. More...
 
virtual void Display (const Handle< V3d_View > &theView, const Quantity_Color &theColor=Quantity_NOC_GRAY)
 Display the plane representation in the choosen view. More...
 
void Erase ()
 Erase the plane representation. More...
 
void Plane (Quantity_Parameter &theA, Quantity_Parameter &theB, Quantity_Parameter &theC, Quantity_Parameter &theD) const
 Returns the parameters of the plane. More...
 
Standard_Boolean IsDisplayed () const
 Returns TRUE when the plane representation is displayed. More...
 
const Handle
< Graphic3d_ClipPlane > & 
ClipPlane () const
 Use this method to pass clipping plane implementation for standard clipping workflow. More...
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual const
Handle_Standard_Type & 
DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const Handle_Standard_Type &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const Handle_Standard_Type &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 

Protected Attributes

Handle< Graphic3d_StructuremyGraphicStructure
 

Detailed Description

Obsolete clip plane presentation class. Ported on new core of Graphic3d_ClipPlane approach. Please access Graphic3d_ClipPlane via ClipPlane() method to use it for standard clipping workflow. Example of use:

Handle(V3d_Plane) aPlane (0, 1, 0, -20);
aView->AddClipPlane (aPlane->ClipPlane());
aPlane->Display (aView);
aPlane->SetPlane (0, 1, 0, -30);
aView->RemoveClipPlane (aPlane->ClipPlane());

Use interface of this class to modify plane equation synchronously with clipping equation.

Constructor & Destructor Documentation

V3d_Plane::V3d_Plane ( const Quantity_Parameter  theA = 0.0,
const Quantity_Parameter  theB = 0.0,
const Quantity_Parameter  theC = 1.0,
const Quantity_Parameter  theD = 0.0 
)

Creates a clipping plane from plane coefficients.

Member Function Documentation

const Handle< Graphic3d_ClipPlane >& V3d_Plane::ClipPlane ( ) const
inline

Use this method to pass clipping plane implementation for standard clipping workflow.

Returns
clipping plane implementation handle.
virtual void V3d_Plane::Display ( const Handle< V3d_View > &  theView,
const Quantity_Color theColor = Quantity_NOC_GRAY 
)
virtual

Display the plane representation in the choosen view.

void V3d_Plane::Erase ( )

Erase the plane representation.

Standard_Boolean V3d_Plane::IsDisplayed ( ) const

Returns TRUE when the plane representation is displayed.

void V3d_Plane::Plane ( Quantity_Parameter theA,
Quantity_Parameter theB,
Quantity_Parameter theC,
Quantity_Parameter theD 
) const

Returns the parameters of the plane.

void V3d_Plane::SetPlane ( const Quantity_Parameter  theA,
const Quantity_Parameter  theB,
const Quantity_Parameter  theC,
const Quantity_Parameter  theD 
)

Change plane equation.

Field Documentation

Handle< Graphic3d_Structure > V3d_Plane::myGraphicStructure
protected

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