Container for properties describing either a Clipping halfspace (single Clipping Plane), or a chain of Clipping Planes defining logical AND (conjunction) operation. The plane equation is specified in "world" coordinate system.
More...
|
| Graphic3d_ClipPlane () |
| Default constructor. Initializes clip plane container with the following properties:
|
|
| Graphic3d_ClipPlane (const Graphic3d_ClipPlane &theOther) |
| Copy constructor.
|
|
| Graphic3d_ClipPlane (const Graphic3d_Vec4d &theEquation) |
| Construct clip plane for the passed equation. By default the plane is on, capping is turned off.
|
|
| Graphic3d_ClipPlane (const gp_Pln &thePlane) |
| Construct clip plane from the passed geometrical definition. By default the plane is on, capping is turned off.
|
|
void | SetEquation (const gp_Pln &thePlane) |
| Set plane equation by its geometrical definition. The equation is specified in "world" coordinate system.
|
|
void | SetEquation (const Graphic3d_Vec4d &theEquation) |
| Set 4-component equation vector for clipping plane. The equation is specified in "world" coordinate system.
|
|
const Graphic3d_Vec4d & | GetEquation () const |
| Get 4-component equation vector for clipping plane.
|
|
const Graphic3d_Vec4d & | ReversedEquation () const |
| Get 4-component equation vector for clipping plane.
|
|
Standard_Boolean | IsOn () const |
| Check that the clipping plane is turned on.
|
|
void | SetOn (const Standard_Boolean theIsOn) |
| Change state of the clipping plane.
|
|
void | SetCapping (const Standard_Boolean theIsOn) |
| Change state of capping surface rendering.
|
|
Standard_Boolean | IsCapping () const |
| Check state of capping surface rendering.
|
|
const gp_Pln & | ToPlane () const |
| Get geometrical definition.
|
|
virtual Handle< Graphic3d_ClipPlane > | Clone () const |
| Clone plane. Virtual method to simplify copying procedure if plane class is redefined at application level to add specific fields to it e.g. id, name, etc.
|
|
Standard_Boolean | IsChain () const |
| Return TRUE if this item defines a conjunction (logical AND) between a set of Planes. Graphic3d_ClipPlane item defines either a Clipping halfspace (single Clipping Plane) or a Clipping volume defined by a logical AND (conjunction) operation between a set of Planes defined as a Chain (so that the volume cuts a space only in case if check fails for ALL Planes in the Chain).
|
|
Handle< Graphic3d_ClipPlane > | ChainPreviousPlane () const |
| Return the previous plane in a Chain of Planes defining logical AND operation, or NULL if there is no Chain or it is a first element in Chain. When clipping is defined by a Chain of Planes, it cuts a space only in case if check fails for all Planes in Chain.
|
|
const Handle< Graphic3d_ClipPlane > & | ChainNextPlane () const |
| Return the next plane in a Chain of Planes defining logical AND operation, or NULL if there is no chain or it is a last element in chain.
|
|
Standard_Integer | NbChainNextPlanes () const |
| Return the number of chains in forward direction (including this item, so it is always >= 1). For a head of Chain - returns the length of entire Chain.
|
|
void | SetChainNextPlane (const Handle< Graphic3d_ClipPlane > &thePlane) |
| Set the next plane in a Chain of Planes. This operation also updates relationship between chains (Previous/Next items), so that the previously set Next plane is cut off.
|
|
Quantity_Color | CappingColor () const |
| Return color for rendering capping surface.
|
|
void | SetCappingColor (const Quantity_Color &theColor) |
| Set color for rendering capping surface.
|
|
void | SetCappingMaterial (const Graphic3d_MaterialAspect &theMat) |
| Set material for rendering capping surface.
|
|
const Graphic3d_MaterialAspect & | CappingMaterial () const |
|
void | SetCappingTexture (const Handle< Graphic3d_TextureMap > &theTexture) |
| Set texture to be applied on capping surface.
|
|
Handle< Graphic3d_TextureMap > | CappingTexture () const |
|
void | SetCappingHatch (const Aspect_HatchStyle theStyle) |
| Set hatch style (stipple) and turn hatching on.
|
|
Aspect_HatchStyle | CappingHatch () const |
|
void | SetCappingCustomHatch (const Handle< Graphic3d_HatchStyle > &theStyle) |
| Set custom hatch style (stipple) and turn hatching on.
|
|
const Handle< Graphic3d_HatchStyle > & | CappingCustomHatch () const |
|
void | SetCappingHatchOn () |
| Turn on hatching.
|
|
void | SetCappingHatchOff () |
| Turn off hatching.
|
|
Standard_Boolean | IsHatchOn () const |
|
const TCollection_AsciiString & | GetId () const |
| This ID is used for managing associated resources in graphical driver. The clip plane can be assigned within a range of IO which can be displayed in separate OpenGl contexts. For each of the context an associated OpenGl resource for graphical aspects should be created and kept. The resources are stored in graphical driver for each of individual groups of shared context under the clip plane identifier.
|
|
const Handle< Graphic3d_AspectFillArea3d > & | CappingAspect () const |
| Return capping aspect.
|
|
void | SetCappingAspect (const Handle< Graphic3d_AspectFillArea3d > &theAspect) |
| Assign capping aspect.
|
|
bool | ToUseObjectMaterial () const |
| Flag indicating whether material for capping plane should be taken from object. Default value: FALSE (use dedicated capping plane material).
|
|
void | SetUseObjectMaterial (bool theToUse) |
| Set flag for controlling the source of capping plane material.
|
|
bool | ToUseObjectTexture () const |
| Flag indicating whether texture for capping plane should be taken from object. Default value: FALSE.
|
|
void | SetUseObjectTexture (bool theToUse) |
| Set flag for controlling the source of capping plane texture.
|
|
bool | ToUseObjectShader () const |
| Flag indicating whether shader program for capping plane should be taken from object. Default value: FALSE.
|
|
void | SetUseObjectShader (bool theToUse) |
| Set flag for controlling the source of capping plane shader program.
|
|
bool | ToUseObjectProperties () const |
| Return true if some fill area aspect properties should be taken from object.
|
|
Graphic3d_ClipState | ProbePoint (const Graphic3d_Vec4d &thePoint) const |
| Check if the given point is outside / inside / on section.
|
|
Graphic3d_ClipState | ProbeBox (const Graphic3d_BndBox3d &theBox) const |
| Check if the given bounding box is fully outside / fully inside.
|
|
Standard_Boolean | ProbeBoxTouch (const Graphic3d_BndBox3d &theBox) const |
| Check if the given bounding box is In and touch the clipping planes.
|
|
Graphic3d_ClipState | ProbePointHalfspace (const Graphic3d_Vec4d &thePoint) const |
| Check if the given point is outside of the half-space (e.g. should be discarded by clipping plane).
|
|
Graphic3d_ClipState | ProbeBoxHalfspace (const Graphic3d_BndBox3d &theBox) const |
| Check if the given bounding box is fully outside / fully inside the half-space.
|
|
bool | IsPointOutHalfspace (const Graphic3d_Vec4d &thePoint) const |
| Check if the given point is outside of the half-space (e.g. should be discarded by clipping plane).
|
|
bool | IsBoxFullOutHalfspace (const Graphic3d_BndBox3d &theBox) const |
| Check if the given bounding box is fully outside of the half-space (e.g. should be discarded by clipping plane).
|
|
Graphic3d_ClipState | ProbeBoxMaxPointHalfspace (const Graphic3d_BndBox3d &theBox) const |
| Check if the given bounding box is fully outside of the half-space (e.g. should be discarded by clipping plane).
|
|
bool | IsBoxFullInHalfspace (const Graphic3d_BndBox3d &theBox) const |
| Check if the given bounding box is fully inside (or touches from inside) the half-space (e.g. NOT discarded by clipping plane).
|
|
virtual void | DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const |
| Dumps the content of me into the stream.
|
|
unsigned int | MCountEquation () const |
|
unsigned int | MCountAspect () const |
|
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.
|
|
Container for properties describing either a Clipping halfspace (single Clipping Plane), or a chain of Clipping Planes defining logical AND (conjunction) operation. The plane equation is specified in "world" coordinate system.