Panda3D
Public Member Functions | Public Attributes | List of all members
TextGraphic Class Reference

This defines a special model that has been constructed for the purposes of embedding an arbitrary graphic image within a text paragraph. More...

Public Member Functions

 __init__ ()
 
 __init__ (const NodePath model, const LVecBase4 frame)
 
 __init__ (const NodePath model, float left, float right, float bottom, float top)
 
 __init__ (const TextGraphic)
 
LVecBase4 getFrame ()
 Returns the frame specified for the graphic. More...
 
bool getInstanceFlag ()
 Returns the instance_flag. More...
 
NodePath getModel ()
 Returns the NodePath associated with the graphic, that renders the desired image. More...
 
 setFrame (const LVecBase4 frame)
 Specifies the (left, right, bottom, top) bounding frame for the graphic. More...
 
 setFrame (float left, float right, float bottom, float top)
 Specifies the (left, right, bottom, top) bounding frame for the graphic. More...
 
 setInstanceFlag (bool instance_flag)
 Sets the instance_flag. More...
 
 setModel (const NodePath model)
 Changes the NodePath associated with the graphic. More...
 

Public Attributes

LVecBase4 frame
 Returns the frame specified for the graphic. More...
 
bool instance_flag
 Returns the instance_flag. More...
 
NodePath model
 Returns the NodePath associated with the graphic, that renders the desired image. More...
 

Detailed Description

This defines a special model that has been constructed for the purposes of embedding an arbitrary graphic image within a text paragraph.

It can be any arbitrary model, though it should be built along the same scale as the text, and it should probably be at least mostly two- dimensional. Typically, this means it should be constructed in the X-Z plane, and it should have a maximum vertical (Z) height of 1.0.

The frame specifies an arbitrary bounding volume in the form (left, right, bottom, top). This indicates the amount of space that will be reserved within the paragraph. The actual model is not actually required to fit within this rectangle, but if it does not, it may visually overlap with nearby text.

Member Function Documentation

◆ __init__() [1/4]

__init__ ( )

◆ __init__() [2/4]

__init__ ( const NodePath  model,
const LVecBase4  frame 
)

◆ __init__() [3/4]

__init__ ( const NodePath  model,
float  left,
float  right,
float  bottom,
float  top 
)

◆ __init__() [4/4]

__init__ ( const  TextGraphic)

◆ getFrame()

LVecBase4 getFrame ( )

Returns the frame specified for the graphic.

This is the amount of space that will be reserved for the graphic when it is embedded in a text paragraph, in the form (left, right, bottom, top).

The actual graphic, as rendered by the NodePath specified via set_model(), should more or less fit within this rectangle. It is not required to fit completely within it, but if it does not, it may visually overlap with nearby text.

◆ getInstanceFlag()

bool getInstanceFlag ( )

Returns the instance_flag.

See set_instance_flag().

◆ getModel()

NodePath getModel ( )

Returns the NodePath associated with the graphic, that renders the desired image.

◆ setFrame() [1/2]

setFrame ( const LVecBase4  frame)

Specifies the (left, right, bottom, top) bounding frame for the graphic.

See get_frame().

◆ setFrame() [2/2]

setFrame ( float  left,
float  right,
float  bottom,
float  top 
)

Specifies the (left, right, bottom, top) bounding frame for the graphic.

See get_frame().

◆ setInstanceFlag()

setInstanceFlag ( bool  instance_flag)

Sets the instance_flag.

When this is true, the graphic is directly instanced to the scene graph whenever it appears; when it is false, the graphic is copied. The default is false, which is best for most applications. You might need to set it true for special kinds of "graphics" like interactive elements, for instance a PGEntry.

◆ setModel()

setModel ( const NodePath  model)

Changes the NodePath associated with the graphic.

This NodePath should contain geometry that will render the desired graphic image.

Member Data Documentation

◆ frame

LVecBase4 frame

Returns the frame specified for the graphic.

This is the amount of space that will be reserved for the graphic when it is embedded in a text paragraph, in the form (left, right, bottom, top).

The actual graphic, as rendered by the NodePath specified via set_model(), should more or less fit within this rectangle. It is not required to fit completely within it, but if it does not, it may visually overlap with nearby text.

◆ instance_flag

bool instance_flag

Returns the instance_flag.

See set_instance_flag().

◆ model

NodePath model

Returns the NodePath associated with the graphic, that renders the desired image.