ui_node_abstractvalue.h

Go to the documentation of this file.

/*
Copyright (C) 2002-2020 UFO: Alien Invasion.

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

#pragma once

class uiAbstractValueNode : public uiLocatedNode {
public:
    void onLoaded(uiNode_t* node) override;
    void onLoading(uiNode_t* node) override;
    void clone(uiNode_t const* source, uiNode_t* clone) override;
    void initNode(uiNode_t* node) override;
    void initNodeDynamic(uiNode_t* node) override;
    void deleteNode(uiNode_t* node) override;

    void setRange(uiNode_t* node, float min, float max);
    bool setValue(uiNode_t* node, float value);
    bool setDelta(uiNode_t* node, float delta);
    bool setMax(uiNode_t* node, float max);
    bool setMin(uiNode_t* node, float min);
    bool incValue(uiNode_t* node);
    bool decValue(uiNode_t* node);

    float getFactorFloat(uiNode_t const* node);
    float getMin(uiNode_t const* node);
    float getMax(uiNode_t const* node);
    float getDelta(uiNode_t const* node);
    float getValue(uiNode_t const* node);
    float getLastDiff (uiNode_t const* node);
    float getShiftIncreaseFactor (uiNode_t* const node);
};

typedef struct abstractValueExtraData_s {
    void* min;  
    void* max;  
    void* value;    
    void* delta;    
    float lastdiff; 
    float shiftIncreaseFactor;
} abstractValueExtraData_t;

struct uiBehaviour_t; /* prototype */

void UI_RegisterAbstractValueNode(uiBehaviour_t* behaviour);

float UI_AbstractValue_GetMin (uiNode_t* node);
float UI_AbstractValue_GetMax (uiNode_t* node);
float UI_AbstractValue_GetValue (uiNode_t* node);
float UI_AbstractValue_GetDelta (uiNode_t* node);
float UI_AbstractValue_GetLastDiff (uiNode_t* node);
float UI_AbstractValue_GetShiftIncreaseFactor (uiNode_t* node);

void UI_AbstractValue_IncValue (uiNode_t* node);
void UI_AbstractValue_DecValue (uiNode_t* node);

void UI_AbstractValue_SetRange (uiNode_t* node, float min, float max);
void UI_AbstractValue_SetMin (uiNode_t* node, float min);
void UI_AbstractValue_SetMax (uiNode_t* node, float max);
void UI_AbstractValue_SetValue (uiNode_t* node, float value);
void UI_AbstractValue_SetDelta (uiNode_t* node, float delta);

void UI_AbstractValue_SetRangeCvar (uiNode_t* node, const char* min, const char* max);
void UI_AbstractValue_SetMinCvar (uiNode_t* node, const char* min);
void UI_AbstractValue_SetMaxCvar (uiNode_t* node, const char* max);
void UI_AbstractValue_SetValueCvar (uiNode_t* node, const char* value);
void UI_AbstractValue_SetShiftIncreaseFactor (uiNode_t* node, float factor);