0027816: Visualization - provide an API for overriding clipping planes list
[occt.git] / src / Graphic3d / Graphic3d_SequenceOfHClipPlane.hxx
CommitLineData
4269bd1b 1// Created on: 2013-07-15
2// Created by: Anton POLETAEV
d5f74e42 3// Copyright (c) 2013-2014 OPEN CASCADE SAS
4269bd1b 4//
973c2be1 5// This file is part of Open CASCADE Technology software library.
4269bd1b 6//
d5f74e42 7// This library is free software; you can redistribute it and/or modify it under
8// the terms of the GNU Lesser General Public License version 2.1 as published
973c2be1 9// by the Free Software Foundation, with special exception defined in the file
10// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11// distribution for complete text of the license and disclaimer of any warranty.
4269bd1b 12//
973c2be1 13// Alternatively, this file may be used under the terms of Open CASCADE
14// commercial license or contractual agreement.
4269bd1b 15
51b10cd4 16#ifndef _Graphic3d_SequenceOfHClipPlane_HeaderFile
17#define _Graphic3d_SequenceOfHClipPlane_HeaderFile
4269bd1b 18
51b10cd4 19#include <NCollection_Sequence.hxx>
3202bf1e 20#include <NCollection_Shared.hxx>
4269bd1b 21#include <Graphic3d_ClipPlane.hxx>
22
3202bf1e 23//! Class defining the sequence of clipping planes.
24class Graphic3d_SequenceOfHClipPlane : public Standard_Transient, public NCollection_Sequence<Handle(Graphic3d_ClipPlane)>
25{
26DEFINE_STANDARD_RTTI_INLINE(Graphic3d_SequenceOfHClipPlane,Standard_Transient)
27public:
28 DEFINE_STANDARD_ALLOC
29 DEFINE_NCOLLECTION_ALLOC
4269bd1b 30
3202bf1e 31 //! Empty constructor.
32 Graphic3d_SequenceOfHClipPlane() : myToOverrideGlobal (Standard_False) {}
33
34 //! Return true if local properties should override global properties.
35 Standard_Boolean ToOverrideGlobal() const { return myToOverrideGlobal; }
36
37 //! Setup flag defining if local properties should override global properties.
38 void SetOverrideGlobal (const Standard_Boolean theToOverride) { myToOverrideGlobal = theToOverride; }
39
40private:
41
42 Standard_Boolean myToOverrideGlobal;
43
44};
45
46DEFINE_STANDARD_HANDLE(Graphic3d_SequenceOfHClipPlane, Standard_Transient)
47
48#endif // _Graphic3d_SequenceOfHClipPlane_HeaderFile