0031687: Draw Harness, ViewerTest - extend command vrenderparams with option updating...
[occt.git] / src / TPrsStd / TPrsStd_Driver.hxx
CommitLineData
42cf5bc1 1// Created on: 1997-08-01
2// Created by: SMO
3// Copyright (c) 1997-1999 Matra Datavision
4// Copyright (c) 1999-2014 OPEN CASCADE SAS
5//
6// This file is part of Open CASCADE Technology software library.
7//
8// This library is free software; you can redistribute it and/or modify it under
9// the terms of the GNU Lesser General Public License version 2.1 as published
10// by the Free Software Foundation, with special exception defined in the file
11// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12// distribution for complete text of the license and disclaimer of any warranty.
13//
14// Alternatively, this file may be used under the terms of Open CASCADE
15// commercial license or contractual agreement.
16
17#ifndef _TPrsStd_Driver_HeaderFile
18#define _TPrsStd_Driver_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_Type.hxx>
22
25e59720 23#include <Standard_Transient.hxx>
42cf5bc1 24#include <Standard_Boolean.hxx>
25class TDF_Label;
26class AIS_InteractiveObject;
27
28
29class TPrsStd_Driver;
25e59720 30DEFINE_STANDARD_HANDLE(TPrsStd_Driver, Standard_Transient)
42cf5bc1 31
32//! Driver for AIS
33//! ==============
34//! An abstract class, which - in classes inheriting
35//! from it - allows you to update an
36//! AIS_InteractiveObject or create one if one does
37//! not already exist.
38//! For both creation and update, the interactive
39//! object is filled with information contained in
40//! attributes. These attributes are those found on
41//! the label given as an argument in the method Update.
42//! true is returned if the interactive object was modified by the update.
43//! This class provide an algorithm to Build with its default
44//! values (if Null) or Update (if !Null) an AIS_InteractiveObject
45//! . Resources are found in attributes associated to a given
46//! label.
25e59720 47class TPrsStd_Driver : public Standard_Transient
42cf5bc1 48{
49
50public:
51
52
53
54 //! Updates the interactive object ais with
55 //! information found on the attributes associated with the label L.
56 Standard_EXPORT virtual Standard_Boolean Update (const TDF_Label& L, Handle(AIS_InteractiveObject)& ais) = 0;
57
58
59
60
25e59720 61 DEFINE_STANDARD_RTTIEXT(TPrsStd_Driver,Standard_Transient)
42cf5bc1 62
63protected:
64
65
66 Standard_EXPORT TPrsStd_Driver();
67
68
69
70private:
71
72
73
74
75};
76
77
78
79
80
81
82
83#endif // _TPrsStd_Driver_HeaderFile