Welcome to mirror list, hosted at ThFree Co, Russian Federation.

im_spacer.h « IMUI « GUI « Source - github.com/WolfireGames/overgrowth.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 52ae1fec65be457a0720fb0d0d5a3808a13de481 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
//-----------------------------------------------------------------------------
//           Name: im_spacer.h
//      Developer: Wolfire Games LLC
//    Description: Blank space element class for creating adhoc GUIs as part 
//                 of the UI tools. You probably don't want to create these 
//                 yourself, instead use the method in Divider
//        License: Read below
//-----------------------------------------------------------------------------
//
//
//   Copyright 2022 Wolfire Games LLC
//
//   Licensed under the Apache License, Version 2.0 (the "License");
//   you may not use this file except in compliance with the License.
//   You may obtain a copy of the License at
//
//       http://www.apache.org/licenses/LICENSE-2.0
//
//   Unless required by applicable law or agreed to in writing, software
//   distributed under the License is distributed on an "AS IS" BASIS,
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//   See the License for the specific language governing permissions and
//   limitations under the License.
//
//-----------------------------------------------------------------------------
#pragma once

#include <GUI/IMUI/im_support.h>
#include <GUI/IMUI/im_element.h>

/*******************************************************************************************/
/**
 * @brief Blank space
 *
 */
class IMSpacer : public IMElement
{

public:
    
    DividerOrientation orientation; // what direction is the host divider
    bool isStatic;  // should this grow and shrink by the needs of its container?

    /*******************************************************************************************/
    /**
     * @brief  Constructor - static divider 
     *
     */
    IMSpacer( DividerOrientation _orientation, float size );
    
    /*******************************************************************************************/
    /**
     * @brief  Constructor - expanding divider 
     *
     */
    IMSpacer( DividerOrientation _orientation );
    IMSpacer();
    
    /*******
     *
     * Angelscript factory
     *
     */
    static IMSpacer* ASFactory_static( DividerOrientation _orientation, float size ) {
        return new IMSpacer( _orientation, size );
    }
    
    static IMSpacer* ASFactory_dynamic( DividerOrientation _orientation ) {
        return new IMSpacer( _orientation );
    }
    
    /*******************************************************************************************/
    /**
     * @brief  Gets the name of the type of this element — for autonaming and debugging
     * 
     * @returns name of the element type as a string
     *
     */
    std::string getElementTypeName();
    
    /*******************************************************************************************/
    /**
     * @brief  Destructor
     *
     */
    virtual ~IMSpacer();
};