source: osgVisual/include/sky_Silverlining/skySilverlining_cloudLayerSlot.h @ 32

Last change on this file since 32 was 32, checked in by Torben Dannhauer, 14 years ago

Adding first version of osgVisual!!

File size: 2.2 KB
Line 
1#pragma once
2/* -*-c++-*- osgVisual - Copyright (C) 2009-2010 Torben Dannhauer
3 *
4 * This library is based on OpenSceneGraph, open source and may be redistributed and/or modified under
5 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
6 * (at your option) any later version.  The full license is in LICENSE file
7 * included with this distribution, and on the openscenegraph.org website.
8 *
9 * osgVisual requires for some proprietary modules a license from the correspondig manufacturer.
10 * You have to aquire licenses for all used proprietary modules.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * OpenSceneGraph Public License for more details.
16 *
17 * This file is based on the OSG example of the Silverlining SDK:
18 * Copyright (c) 2008 Sundog Software, LLC. All rights reserved worldwide.
19*/
20
21#include <SilverLining.h>
22#include <string>
23
24
25namespace osgVisual
26{
27
28/**
29 * \brief This class represents a single cloudlayer slot which contains a cloud layer and corresponding additional information.
30 *
31 * @author Torben Dannhauer
32 * @date  Sep 2009
33 */ 
34class cloudLayerSlot
35{
36public:
37        /**
38         * \brief Construtor, which initializes the cloudlayer information with valid default values.
39         *
40         */ 
41        cloudLayerSlot() 
42        {
43                slot_id = -1;
44                used = false;
45                enabled = false;
46                cloudLayerHandle = -1;
47                cloudLayerPointer = NULL;
48                typeName = "";
49        };
50
51        /**
52         * ID of the cloudlayer slot.
53         */ 
54        int slot_id;
55
56        /**
57         * This flag indicates if the cloudlayer slot is in use.
58         *
59         * @todo : Explain diff to 'enabled'.
60         */ 
61        bool used;
62
63        /**
64         * This flag indicates if the cloudlayer slot is enabled.
65         *
66         * @todo : Explain diff to 'used'.
67         */ 
68        bool enabled;
69
70        /**
71         * This variable contains silverlining's cloudlayer handle-ID.
72         */ 
73        int cloudLayerHandle;
74
75        /**
76         * Pointer to the cloudlayer object.
77         */ 
78        SilverLining::CloudLayer *cloudLayerPointer;
79
80        /**
81         * Literal name of the cloudlayer type. e.g. CUMULUS_MEDIOCRIS.
82         */ 
83        std::string typeName;
84};
85
86}       // END NAMESPACE
Note: See TracBrowser for help on using the repository browser.