closes #251 Two related bugs where Python garbage collection destroyed callbacks that were still needed by live C++ objects: 1. **Drawable callbacks (all 8 types)**: tp_dealloc unconditionally called click_unregister() etc., destroying callbacks even when the C++ object was still alive in a parent's children vector. Fixed by guarding with shared_ptr::use_count() <= 1 — only unregister when the Python wrapper is the last owner. 2. **Timer GC prevention**: Active timers now hold a Py_INCREF'd reference to their Python wrapper (Timer::py_wrapper), preventing GC while the timer is registered in the engine. Released on stop(), one-shot fire, or destruction. mcrfpy.Timer("name", cb, 100) now works without storing the return value. Also includes audio synth demo UI fixes: button click handling (don't set on_click on Caption children), single-column slider layout, improved Animalese contrast. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
202 lines
9.4 KiB
C++
202 lines
9.4 KiB
C++
#pragma once
|
|
#include "Common.h"
|
|
#include "Python.h"
|
|
#include "structmember.h"
|
|
#include "IndexTexture.h"
|
|
#include "Resources.h"
|
|
#include <list>
|
|
|
|
#include "PyCallable.h"
|
|
#include "PyTexture.h"
|
|
#include "PyDrawable.h"
|
|
#include "PyColor.h"
|
|
#include "PyVector.h"
|
|
#include "PyFont.h"
|
|
#include "UIDrawable.h"
|
|
#include "UIBase.h"
|
|
|
|
class UISprite: public UIDrawable
|
|
{
|
|
private:
|
|
int sprite_index;
|
|
sf::Sprite sprite;
|
|
protected:
|
|
std::shared_ptr<PyTexture> ptex;
|
|
public:
|
|
UISprite();
|
|
UISprite(std::shared_ptr<PyTexture>, int, sf::Vector2f, float);
|
|
|
|
// Copy constructor and assignment operator
|
|
UISprite(const UISprite& other);
|
|
UISprite& operator=(const UISprite& other);
|
|
|
|
// Move constructor and assignment operator
|
|
UISprite(UISprite&& other) noexcept;
|
|
UISprite& operator=(UISprite&& other) noexcept;
|
|
void update();
|
|
void render(sf::Vector2f, sf::RenderTarget&) override final;
|
|
virtual UIDrawable* click_at(sf::Vector2f point) override final;
|
|
|
|
//void render(sf::Vector2f, sf::RenderTexture&);
|
|
|
|
void setPosition(sf::Vector2f);
|
|
sf::Vector2f getPosition();
|
|
void setScale(sf::Vector2f);
|
|
sf::Vector2f getScale() const;
|
|
void setSpriteIndex(int);
|
|
int getSpriteIndex();
|
|
|
|
void setTexture(std::shared_ptr<PyTexture> _ptex, int _sprite_index=-1);
|
|
std::shared_ptr<PyTexture> getTexture();
|
|
|
|
PyObjectsEnum derived_type() override final;
|
|
|
|
// Phase 1 virtual method implementations
|
|
sf::FloatRect get_bounds() const override;
|
|
void move(float dx, float dy) override;
|
|
void resize(float w, float h) override;
|
|
void onPositionChanged() override;
|
|
|
|
// Property system for animations
|
|
bool setProperty(const std::string& name, float value) override;
|
|
bool setProperty(const std::string& name, int value) override;
|
|
bool getProperty(const std::string& name, float& value) const override;
|
|
bool getProperty(const std::string& name, int& value) const override;
|
|
|
|
bool hasProperty(const std::string& name) const override;
|
|
|
|
static PyObject* get_float_member(PyUISpriteObject* self, void* closure);
|
|
static int set_float_member(PyUISpriteObject* self, PyObject* value, void* closure);
|
|
static PyObject* get_int_member(PyUISpriteObject* self, void* closure);
|
|
static int set_int_member(PyUISpriteObject* self, PyObject* value, void* closure);
|
|
static PyObject* get_texture(PyUISpriteObject* self, void* closure);
|
|
static int set_texture(PyUISpriteObject* self, PyObject* value, void* closure);
|
|
static PyObject* get_pos(PyUISpriteObject* self, void* closure);
|
|
static int set_pos(PyUISpriteObject* self, PyObject* value, void* closure);
|
|
static PyGetSetDef getsetters[];
|
|
static PyObject* repr(PyUISpriteObject* self);
|
|
static int init(PyUISpriteObject* self, PyObject* args, PyObject* kwds);
|
|
|
|
};
|
|
|
|
// Forward declaration of methods array
|
|
extern PyMethodDef UISprite_methods[];
|
|
|
|
namespace mcrfpydef {
|
|
inline PyTypeObject PyUISpriteType = {
|
|
.ob_base = {.ob_base = {.ob_refcnt = 1, .ob_type = NULL}, .ob_size = 0},
|
|
.tp_name = "mcrfpy.Sprite",
|
|
.tp_basicsize = sizeof(PyUISpriteObject),
|
|
.tp_itemsize = 0,
|
|
.tp_dealloc = (destructor)[](PyObject* self)
|
|
{
|
|
PyUISpriteObject* obj = (PyUISpriteObject*)self;
|
|
// Untrack from GC before destroying
|
|
PyObject_GC_UnTrack(self);
|
|
// Clear weak references
|
|
if (obj->weakreflist != NULL) {
|
|
PyObject_ClearWeakRefs(self);
|
|
}
|
|
// Only unregister callbacks if we're the last owner (#251)
|
|
if (obj->data && obj->data.use_count() <= 1) {
|
|
obj->data->click_unregister();
|
|
obj->data->on_enter_unregister();
|
|
obj->data->on_exit_unregister();
|
|
obj->data->on_move_unregister();
|
|
}
|
|
obj->data.reset();
|
|
Py_TYPE(self)->tp_free(self);
|
|
},
|
|
.tp_repr = (reprfunc)UISprite::repr,
|
|
//.tp_hash = NULL,
|
|
//.tp_iter
|
|
//.tp_iternext
|
|
.tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
|
|
.tp_doc = PyDoc_STR("Sprite(pos=None, texture=None, sprite_index=0, **kwargs)\n\n"
|
|
"A sprite UI element that displays a texture or portion of a texture atlas.\n\n"
|
|
"Args:\n"
|
|
" pos (tuple, optional): Position as (x, y) tuple. Default: (0, 0)\n"
|
|
" texture (Texture, optional): Texture object to display. Default: default texture\n"
|
|
" sprite_index (int, optional): Index into texture atlas. Default: 0\n\n"
|
|
"Keyword Args:\n"
|
|
" scale (float): Uniform scale factor. Default: 1.0\n"
|
|
" scale_x (float): Horizontal scale factor. Default: 1.0\n"
|
|
" scale_y (float): Vertical scale factor. Default: 1.0\n"
|
|
" click (callable): Click event handler. Default: None\n"
|
|
" visible (bool): Visibility state. Default: True\n"
|
|
" opacity (float): Opacity (0.0-1.0). Default: 1.0\n"
|
|
" z_index (int): Rendering order. Default: 0\n"
|
|
" name (str): Element name for finding. Default: None\n"
|
|
" x (float): X position override. Default: 0\n"
|
|
" y (float): Y position override. Default: 0\n"
|
|
" align (Alignment): Alignment relative to parent. Default: None\n"
|
|
" margin (float): Margin from parent edge when aligned. Default: 0\n"
|
|
" horiz_margin (float): Horizontal margin override. Default: 0 (use margin)\n"
|
|
" vert_margin (float): Vertical margin override. Default: 0 (use margin)\n\n"
|
|
"Attributes:\n"
|
|
" x, y (float): Position in pixels\n"
|
|
" pos (Vector): Position as a Vector object\n"
|
|
" texture (Texture): The texture being displayed\n"
|
|
" sprite_index (int): Current sprite index in texture atlas\n"
|
|
" scale (float): Uniform scale factor\n"
|
|
" scale_x, scale_y (float): Individual scale factors\n"
|
|
" click (callable): Click event handler\n"
|
|
" visible (bool): Visibility state\n"
|
|
" opacity (float): Opacity value\n"
|
|
" z_index (int): Rendering order\n"
|
|
" name (str): Element name\n"
|
|
" w, h (float): Read-only computed size based on texture and scale\n"
|
|
" align (Alignment): Alignment relative to parent (or None)\n"
|
|
" margin (float): General margin for alignment\n"
|
|
" horiz_margin (float): Horizontal margin override\n"
|
|
" vert_margin (float): Vertical margin override"),
|
|
// tp_traverse visits Python object references for GC cycle detection
|
|
.tp_traverse = [](PyObject* self, visitproc visit, void* arg) -> int {
|
|
PyUISpriteObject* obj = (PyUISpriteObject*)self;
|
|
if (obj->data) {
|
|
if (obj->data->click_callable) {
|
|
PyObject* callback = obj->data->click_callable->borrow();
|
|
if (callback && callback != Py_None) Py_VISIT(callback);
|
|
}
|
|
if (obj->data->on_enter_callable) {
|
|
PyObject* callback = obj->data->on_enter_callable->borrow();
|
|
if (callback && callback != Py_None) Py_VISIT(callback);
|
|
}
|
|
if (obj->data->on_exit_callable) {
|
|
PyObject* callback = obj->data->on_exit_callable->borrow();
|
|
if (callback && callback != Py_None) Py_VISIT(callback);
|
|
}
|
|
if (obj->data->on_move_callable) {
|
|
PyObject* callback = obj->data->on_move_callable->borrow();
|
|
if (callback && callback != Py_None) Py_VISIT(callback);
|
|
}
|
|
}
|
|
return 0;
|
|
},
|
|
// tp_clear breaks reference cycles by clearing Python references
|
|
.tp_clear = [](PyObject* self) -> int {
|
|
PyUISpriteObject* obj = (PyUISpriteObject*)self;
|
|
if (obj->data) {
|
|
obj->data->click_unregister();
|
|
obj->data->on_enter_unregister();
|
|
obj->data->on_exit_unregister();
|
|
obj->data->on_move_unregister();
|
|
}
|
|
return 0;
|
|
},
|
|
.tp_methods = UISprite_methods,
|
|
//.tp_members = PyUIFrame_members,
|
|
.tp_getset = UISprite::getsetters,
|
|
.tp_base = &mcrfpydef::PyDrawableType,
|
|
.tp_init = (initproc)UISprite::init,
|
|
.tp_new = [](PyTypeObject* type, PyObject* args, PyObject* kwds) -> PyObject*
|
|
{
|
|
PyUISpriteObject* self = (PyUISpriteObject*)type->tp_alloc(type, 0);
|
|
if (self) {
|
|
self->data = std::make_shared<UISprite>();
|
|
self->weakreflist = nullptr;
|
|
}
|
|
return (PyObject*)self;
|
|
}
|
|
};
|
|
}
|