Panda3D
|
This defines a special model that has been constructed for the purposes of embedding an arbitrary graphic image within a text paragraph. More...
#include "textGraphic.h"
Public Member Functions | |
TextGraphic (const NodePath &model, const LVecBase4 &frame) | |
TextGraphic (const NodePath &model, PN_stdfloat left, PN_stdfloat right, PN_stdfloat bottom, PN_stdfloat top) | |
LVecBase4 | get_frame () const |
Returns the frame specified for the graphic. More... | |
bool | get_instance_flag () const |
Returns the instance_flag. More... | |
NodePath | get_model () const |
Returns the NodePath associated with the graphic, that renders the desired image. More... | |
void | set_frame (const LVecBase4 &frame) |
Specifies the (left, right, bottom, top) bounding frame for the graphic. More... | |
void | set_frame (PN_stdfloat left, PN_stdfloat right, PN_stdfloat bottom, PN_stdfloat top) |
Specifies the (left, right, bottom, top) bounding frame for the graphic. More... | |
void | set_instance_flag (bool instance_flag) |
Sets the instance_flag. More... | |
void | set_model (const NodePath &model) |
Changes the NodePath associated with the graphic. More... | |
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.
Definition at line 43 of file textGraphic.h.
|
inline |
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.
Definition at line 91 of file textGraphic.I.
References set_frame().
Referenced by TextAssembler::calc_width(), TextAssembler::is_whitespace(), and set_model().
|
inline |
Returns the instance_flag.
See set_instance_flag().
Definition at line 123 of file textGraphic.I.
References set_instance_flag().
Referenced by TextAssembler::is_whitespace(), and set_frame().
|
inline |
Returns the NodePath associated with the graphic, that renders the desired image.
Definition at line 60 of file textGraphic.I.
References set_model().
Referenced by TextAssembler::is_whitespace().
|
inline |
Specifies the (left, right, bottom, top) bounding frame for the graphic.
See get_frame().
Definition at line 102 of file textGraphic.I.
Referenced by get_frame().
|
inline |
Specifies the (left, right, bottom, top) bounding frame for the graphic.
See get_frame().
Definition at line 113 of file textGraphic.I.
References get_instance_flag().
|
inline |
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.
Definition at line 139 of file textGraphic.I.
Referenced by get_instance_flag().
|
inline |
Changes the NodePath associated with the graphic.
This NodePath should contain geometry that will render the desired graphic image.
Definition at line 72 of file textGraphic.I.
References get_frame().
Referenced by get_model().