panda3d/direct/src/gui/Label.py

from ShowBaseGlobal import *
from DirectObject import *
from GuiGlobals import *

## These are the styles of labels we might commonly see.  They control
## the way the label looks.

ButtonUp = 1
ButtonLit = 2
ButtonDown = 3
Sign = 4
ScrollTitle = 5
ScrollItem = 6


def textLabel(string, style,
              scale = 0.1,
              width = None,
              drawOrder = getDefaultDrawOrder(),
              font = getDefaultFont()):
    """textLabel(string, int style, float scale, float width,
                 int drawOrder, Node font)

    Generates a text label suitable for adding to a GuiButton or
    GuiSign.

    """
    
    (label, text) = \
            textLabelAndText(string, style, scale, width, drawOrder, font)
    return label
    
def textLabelAndText(string, style,
                     scale = 0.1,
                     width = None,
                     drawOrder = getDefaultDrawOrder(),
                     font = getDefaultFont()):
    """textLabelAndText(string, int style, float scale, float width,
                        int drawOrder, Node font)

    Generates a text label suitable for adding to a GuiButton or
    GuiSign.

    This function returns both the label and the TextNode that is
    within the label, allowing the calling function to update the
    label's text later.  If there are a limited number of text
    strings, however, it would probably be better to create a separate
    GuiItem for each possible text string, and rotate them in and out.

    """
    text = TextNode()

    # Freeze the text so we can set up its properties.
    text.freeze()
    
    text.setFont(font)
    text.setAlign(TMALIGNCENTER)
    text.setDrawOrder(drawOrder)
    text.setTextColor(0.0, 0.0, 0.0, 1.0)
    text.setCardColor(1.0, 1.0, 1.0, 1.0)
    text.setCardAsMargin(0.1, 0.1, 0.0, 0.0)
    text.setTransform(Mat4.scaleMat(scale))

    if style == ButtonUp:
        # This is the default: black on white.
        pass
        
    elif style == ButtonLit:
        # When the mouse is over the button, the background turns
        # yellow.
        text.setCardColor(1.0, 1.0, 0.0, 1.0)
        
    elif style == ButtonDown:
        # When the button is being depressed, its turns to white
        # on black.
        text.setTextColor(1.0, 1.0, 1.0, 1.0)
        text.setCardColor(0.0, 0.0, 0.0, 1.0)
        
    elif style == Sign:
        # For a sign, we want red text with no background card.
        text.setTextColor(1., 0., 0., 1.)
        text.clearCard()

    elif style == ScrollTitle:
        text.setTextColor(1., 0., 0., 1.)
        text.setCardColor(1., 1., 1., 0.)
    
    elif style == ScrollItem:
        pass


    # Don't set the text until the very last thing, so the TextNode
    # has minimal work to do (even though it's frozen).
    text.setText(string)

    v = text.getCardActual()

    if width != None:
        # If the user specified a specific width to use, keep it.
        v = VBase4(-width / 2.0, width / 2.0, v[2], v[3])
        if text.hasCard():
            text.setCardActual(v[0], v[1], v[2], v[3])

    # Now we're completely done setting up the text, and we can safely
    # thaw it.
    text.thaw()

    # Now create a GuiLabel containing this text.
    label = GuiLabel.makeModelLabel(text, v[0] * scale, v[1] * scale,
                                    v[2] * scale, v[3] * scale)

    label.setDrawOrder(drawOrder)
    return (label, text)


def modelLabel(model,
               geomRect = None,
               scale = 0.1,
               drawOrder = getDefaultDrawOrder()):

    # Preserve transitions on the arc by creating an intervening node.
    topnode = NamedNode('model')
    topnp = NodePath(topnode)
    mi = model.instanceTo(topnp)
    mi.setScale(scale)
    mi.setBin('fixed', drawOrder)

    if geomRect == None:
        geomRect = (1, 1)

    if len(geomRect) == 2:
        # If we got only two parameters, it's height and width.
        label = GuiLabel.makeModelLabel(topnode,
                                        geomRect[0] * scale,
                                        geomRect[1] * scale)
    elif len(geomRect) == 4:
        # If we got four, they're left, right, bottom, top.
        label = GuiLabel.makeModelLabel(topnode,
                                        geomRect[0] * scale,
                                        geomRect[1] * scale,
                                        geomRect[2] * scale,
                                        geomRect[3] * scale)
    else:
        raise ValueError
    
    label.setDrawOrder(drawOrder)
    return label