1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-07-30 13:05:50 +03:00
occt/src/IVtkOCC/IVtkOCC_SelectableObject.hxx
dpasukhi 604c3b890c Documentation - Update parameter annotations for consistency #161
Reorganized style for param to the next templates:
 - "@param theParameter description ..."
 - "@param[in] theParameter description ..."
 - "@param[out] theParameter description ..."
 - "@param[in][out] theParameter description ..."
 The replacement was with keeping spacing, no removing of extra spaces.
In some files '/' was used instead of '@', that was not updated yet.
2024-11-17 20:22:51 +00:00

79 lines
2.8 KiB
C++

// Created on: 2011-10-20
// Created by: Roman KOZLOV
// Copyright (c) 2011-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.
#ifndef __IVTKOCC_SELECTABLEOBJECT_H__
#define __IVTKOCC_SELECTABLEOBJECT_H__
#include <Bnd_Box.hxx>
#include <IVtkOCC_Shape.hxx>
#include <Prs3d_Drawer.hxx>
#include <SelectMgr_SelectableObject.hxx>
#include <SelectMgr_Selection.hxx>
class IVtkOCC_SelectableObject;
DEFINE_STANDARD_HANDLE(IVtkOCC_SelectableObject, SelectMgr_SelectableObject)
// -----------------------------------------------------------------------------
//! @class IVtkOCC_SelectableObject
//! @brief Class with selection primitives used by OCCT selection algorithm.
class IVtkOCC_SelectableObject : public SelectMgr_SelectableObject
{
public:
typedef Handle(IVtkOCC_SelectableObject) Handle;
//! Constructs a selectable object initialized by the given shape
//! @param[in] theShape Selectable shape
IVtkOCC_SelectableObject (const IVtkOCC_Shape::Handle& theShape);
//! Constructs uninitialized selectable object.
//! setShape() should be called later.
IVtkOCC_SelectableObject();
virtual ~IVtkOCC_SelectableObject();
//! Sets the selectable shape
//! @param[in] theShape Selectable shape
Standard_EXPORT void SetShape (const IVtkOCC_Shape::Handle& theShape);
const IVtkOCC_Shape::Handle& GetShape() const { return myShape; };
//! Returns bounding box of object
Standard_EXPORT virtual void BoundingBox (Bnd_Box& theBndBox) Standard_OVERRIDE;
DEFINE_STANDARD_RTTIEXT(IVtkOCC_SelectableObject,SelectMgr_SelectableObject)
private:
//! Internal method, computes selection data for viewer selector
//! Inspired by AIS_Shape::ComputeSelection() from OCCT 6.5.1
//! @param[in] selection container for sensitive primitives
//! @param[in] mode Selection mode
virtual void ComputeSelection (const Handle(SelectMgr_Selection)& theSelection,
const Standard_Integer theMode) Standard_OVERRIDE;
//! Dummy.
virtual void Compute (const Handle(PrsMgr_PresentationManager)& ,
const Handle(Prs3d_Presentation)& ,
const Standard_Integer ) Standard_OVERRIDE {}
const Bnd_Box& BoundingBox();
private:
IVtkOCC_Shape::Handle myShape;
Bnd_Box myBndBox;
};
#endif // __IVTKOCC_SELECTABLEOBJECT_H__