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:

Public Member Functions
	V3d_Plane (const Standard_Real theA=0.0, const Standard_Real theB=0.0, const Standard_Real theC=1.0, const Standard_Real theD=0.0)
	Creates a clipping plane from plane coefficients.
void	SetPlane (const Standard_Real theA, const Standard_Real theB, const Standard_Real theC, const Standard_Real theD)
	Change plane equation.
virtual void	Display (const Handle< V3d_View > &theView, const Quantity_Color &theColor=Quantity_NOC_GRAY)
	Display the plane representation in the chosen view.
void	Erase ()
	Erase the plane representation.
void	Plane (Standard_Real &theA, Standard_Real &theB, Standard_Real &theC, Standard_Real &theD) const
	Returns the parameters of the plane.
Standard_Boolean	IsDisplayed () const
	Returns TRUE when the plane representation is displayed.
const Handle< Graphic3d_ClipPlane > &	ClipPlane () const
	Use this method to pass clipping plane implementation for standard clipping workflow.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
Standard_Boolean	IsKind (const opencascade::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.
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.
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Attributes
Handle< Graphic3d_Structure >	myGraphicStructure

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

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);
Handle(V3d_View) aView;
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::V3d_Plane	(	const Standard_Real	theA = 0.0,
		const Standard_Real	theB = 0.0,
		const Standard_Real	theC = 1.0,
		const Standard_Real	theD = 0.0
	)

Creates a clipping plane from plane coefficients.

Member Function Documentation

ClipPlane()

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.

Display()

virtual void V3d_Plane::Display ( const Handle< V3d_View > &  theView, const Quantity_Color &  theColor = Quantity_NOC_GRAY  )

virtual

Display the plane representation in the chosen view.

Erase()

void V3d_Plane::Erase

(

)

Erase the plane representation.

IsDisplayed()

Standard_Boolean V3d_Plane::IsDisplayed

(

)

const

Returns TRUE when the plane representation is displayed.

Plane()

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

Returns the parameters of the plane.

SetPlane()

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

Change plane equation.

Field Documentation

myGraphicStructure

Handle< Graphic3d_Structure > V3d_Plane::myGraphicStructure

protected

---

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

• V3d_Plane.hxx