OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    AIS_LightSourceOwner Class Reference

    Owner of AIS_LightSource presentation. More...

    #include <AIS_LightSource.hxx>

    Inheritance diagram for AIS_LightSourceOwner:

    Public Member Functions

     AIS_LightSourceOwner (const occ::handle< AIS_LightSource > &theObject, int thePriority=5)
     Main constructor.
    bool HandleMouseClick (const NCollection_Vec2< int > &thePoint, Aspect_VKeyMouse theButton, Aspect_VKeyFlags theModifiers, bool theIsDoubleClick) override
     Handle mouse button click event.
    void HilightWithColor (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr, const occ::handle< Prs3d_Drawer > &theStyle, const int theMode) override
     Highlights selectable object's presentation with display mode in presentation manager with given highlight style. Also a check for auto-highlight is performed - if selectable object manages highlighting on its own, execution will be passed to SelectMgr_SelectableObject::HilightOwnerWithColor method.
    bool IsForcedHilight () const override
     Always update dynamic highlighting.
    Public Member Functions inherited from SelectMgr_EntityOwner
     SelectMgr_EntityOwner (const int aPriority=0)
     Initializes the selection priority aPriority.
     SelectMgr_EntityOwner (const occ::handle< SelectMgr_SelectableObject > &aSO, const int aPriority=0)
     Constructs a framework with the selectable object anSO being attributed the selection priority aPriority.
     SelectMgr_EntityOwner (const occ::handle< SelectMgr_EntityOwner > &theOwner, const int aPriority=0)
     Constructs a framework from existing one anSO being attributed the selection priority aPriority.
    int Priority () const
     Return selection priority (within range [0-9]) for results with the same depth; 0 by default. Example - selection of shapes: the owners are selectable objects (presentations) a user can give vertex priority [3], edges [2] faces [1] shape [0], so that if during selection one vertex one edge and one face are simultaneously detected, the vertex will only be hilighted.
    void SetPriority (int thePriority)
     Sets the selectable priority of the owner within range [0-9].
    bool HasSelectable () const
     Returns true if there is a selectable object to serve as an owner.
    virtual occ::handle< SelectMgr_SelectableObject > Selectable () const
     Returns a selectable object detected in the working context.
    virtual void SetSelectable (const occ::handle< SelectMgr_SelectableObject > &theSelObj)
     Sets the selectable object.
    virtual bool IsHilighted (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr, const int theMode=0) const
     Returns true if the presentation manager highlights selections corresponding to the selection mode.
    virtual void Unhilight (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr, const int theMode=0)
     Removes highlighting from the owner of a detected selectable object in the presentation manager. This object could be the owner of a sensitive primitive.
    virtual void Clear (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr, const int theMode=0)
     Clears the owners matching the value of the selection mode aMode from the presentation manager object aPM.
    virtual bool HasLocation () const
     Returns TRUE if selectable has transformation.
    virtual TopLoc_Location Location () const
     Returns transformation of selectable.
    virtual void SetLocation (const TopLoc_Location &theLocation)
     Change owner location (callback for handling change of location of selectable object).
    bool IsSelected () const
    void SetSelected (const bool theIsSelected)
     Set the state of the owner.
    bool Select (const AIS_SelectionScheme theSelScheme, const bool theIsDetected) const
     If the object needs to be selected, it returns true.
    int State () const
     Returns selection state.
    void State (const int theStatus)
     Set the state of the owner. The method is deprecated. Use SetSelected() instead.
    virtual bool IsAutoHilight () const
     if owner is not auto hilighted, for group contains many such owners will be called one method HilightSelected of SelectableObject
    virtual void SetZLayer (const Graphic3d_ZLayerId theLayerId)
     Set Z layer ID and update all presentations.
    virtual void UpdateHighlightTrsf (const occ::handle< V3d_Viewer > &theViewer, const occ::handle< PrsMgr_PresentationManager > &theManager, const int theDispMode)
     Implements immediate application of location transformation of parent object to dynamic highlight structure.
    bool IsSameSelectable (const occ::handle< SelectMgr_SelectableObject > &theOther) const
     Returns true if pointer to selectable object of this owner is equal to the given one.
    bool ComesFromDecomposition () const
     Returns TRUE if this owner points to a part of object and FALSE for entire object.
    void SetComesFromDecomposition (const bool theIsFromDecomposition)
     Sets flag indicating this owner points to a part of object (TRUE) or to entire object (FALSE).
    virtual void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
     Dumps the content of me into the stream.
    void Set (const occ::handle< SelectMgr_SelectableObject > &theSelObj)
     Sets the selectable object.
    void Set (const int thePriority)
     sets the selectable priority of the owner
    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 ()=default
     Destructor must be virtual.
    virtual const opencascade::handle< Standard_Type > & DynamicType () const
     Returns a type descriptor about this object.
    bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
     Returns a true value if this is an instance of Type.
    bool IsInstance (const char *const theTypeName) const
     Returns a true value if this is an instance of TypeName.
    bool 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.
    bool IsKind (const char *const 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.
    int GetRefCount () const noexcept
     Get the reference counter of this object.
    void IncrementRefCounter () noexcept
     Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
    int DecrementRefCounter () noexcept
     Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
    virtual void Delete () const
     Memory deallocator for transient classes.

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    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.
    Protected Attributes inherited from SelectMgr_EntityOwner
    SelectMgr_SelectableObject * mySelectable
     raw pointer to selectable object
    int mypriority
     selection priority (for result with the same depth)
    bool myIsSelected
     flag indicating selected state
    bool myFromDecomposition
     flag indicating this owner points to a part of object (TRUE) or to entire object (FALSE)

    Detailed Description

    Owner of AIS_LightSource presentation.

    Constructor & Destructor Documentation

    ◆ AIS_LightSourceOwner()

    AIS_LightSourceOwner::AIS_LightSourceOwner ( const occ::handle< AIS_LightSource > & theObject,
    int thePriority = 5 )

    Main constructor.

    Member Function Documentation

    ◆ HandleMouseClick()

    bool AIS_LightSourceOwner::HandleMouseClick ( const NCollection_Vec2< int > & thePoint,
    Aspect_VKeyMouse theButton,
    Aspect_VKeyFlags theModifiers,
    bool theIsDoubleClick )
    overridevirtual

    Handle mouse button click event.

    Reimplemented from SelectMgr_EntityOwner.

    ◆ HilightWithColor()

    void AIS_LightSourceOwner::HilightWithColor ( const occ::handle< PrsMgr_PresentationManager > & thePrsMgr,
    const occ::handle< Prs3d_Drawer > & theStyle,
    const int theMode )
    overridevirtual

    Highlights selectable object's presentation with display mode in presentation manager with given highlight style. Also a check for auto-highlight is performed - if selectable object manages highlighting on its own, execution will be passed to SelectMgr_SelectableObject::HilightOwnerWithColor method.

    Reimplemented from SelectMgr_EntityOwner.

    ◆ IsForcedHilight()

    bool AIS_LightSourceOwner::IsForcedHilight ( ) const
    overridevirtual

    Always update dynamic highlighting.

    Reimplemented from SelectMgr_EntityOwner.


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