GNU Octave  9.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
image::properties Class Reference

#include "graphics.h"

Inheritance diagram for image::properties:
base_properties

Public Types

enum  {
  ID_ALPHADATA = 6000 , ID_ALPHADATAMAPPING = 6001 , ID_CDATA = 6002 , ID_CDATAMAPPING = 6003 ,
  ID_XDATA = 6004 , ID_YDATA = 6005 , ID_ALIM = 6006 , ID_CLIM = 6007 ,
  ID_XLIM = 6008 , ID_YLIM = 6009 , ID_ALIMINCLUDE = 6010 , ID_CLIMINCLUDE = 6011 ,
  ID_XLIMINCLUDE = 6012 , ID_YLIMINCLUDE = 6013 , ID_XDATAMODE = 6014 , ID_YDATAMODE = 6015
}
 
- Public Types inherited from base_properties
enum  {
  ID_BEINGDELETED = 0 , ID_BUSYACTION = 1 , ID_BUTTONDOWNFCN = 2 , ID_CHILDREN = 3 ,
  ID_CLIPPING = 4 , ID_CONTEXTMENU = 5 , ID_CREATEFCN = 6 , ID_DELETEFCN = 7 ,
  ID_HANDLEVISIBILITY = 8 , ID_HITTEST = 9 , ID_INTERRUPTIBLE = 10 , ID_PARENT = 11 ,
  ID_PICKABLEPARTS = 12 , ID_SELECTED = 13 , ID_SELECTIONHIGHLIGHT = 14 , ID_TAG = 15 ,
  ID_TYPE = 16 , ID_UICONTEXTMENU = 17 , ID_USERDATA = 18 , ID_VISIBLE = 19 ,
  ID___APPDATA__ = 20 , ID___MODIFIED__ = 21 , ID___MYHANDLE__ = 22
}
 

Public Member Functions

 properties ()=delete
 
 properties (const graphics_handle &mh, const graphics_handle &p)
 
 ~properties ()=default
 
std::set< std::string > all_property_names () const
 
bool alphadatamapping_is (const std::string &v) const
 
bool cdatamapping_is (const std::string &v) const
 
octave_value get (bool all=false) const
 
octave_value get (const caseless_str &pname) const
 
octave_value get (const char *pname) const
 
octave_value get (const std::string &pname) const
 
octave_value get_alim () const
 
std::string get_aliminclude () const
 
octave_value get_alphadata () const
 
std::string get_alphadatamapping () const
 
octave_value get_cdata () const
 
std::string get_cdatamapping () const
 
octave_value get_clim () const
 
std::string get_climinclude () const
 
octave_value get_color_data () const
 
property get_property (const caseless_str &pname)
 
octave_value get_xdata () const
 
std::string get_xdatamode () const
 
octave_value get_xlim () const
 
std::string get_xliminclude () const
 
octave_value get_ydata () const
 
std::string get_ydatamode () const
 
octave_value get_ylim () const
 
std::string get_yliminclude () const
 
std::string graphics_object_name () const
 
bool has_property (const caseless_str &pname) const
 
void initialize_data ()
 
bool is_aliminclude () const
 
bool is_climinclude () const
 
bool is_xliminclude () const
 
bool is_yliminclude () const
 
float pixel_xsize ()
 
float pixel_ysize ()
 
void set (const caseless_str &pname, const octave_value &val)
 
void set_alim (const octave_value &val)
 
void set_aliminclude (const octave_value &val)
 
void set_alphadata (const octave_value &val)
 
void set_alphadatamapping (const octave_value &val)
 
void set_cdata (const octave_value &val)
 
void set_cdatamapping (const octave_value &val)
 
void set_clim (const octave_value &val)
 
void set_climinclude (const octave_value &val)
 
void set_xdata (const octave_value &val)
 
void set_xdatamode (const octave_value &val)
 
void set_xlim (const octave_value &val)
 
void set_xliminclude (const octave_value &val)
 
void set_ydata (const octave_value &val)
 
void set_ydatamode (const octave_value &val)
 
void set_ylim (const octave_value &val)
 
void set_yliminclude (const octave_value &val)
 
bool xdatamode_is (const std::string &v) const
 
bool ydatamode_is (const std::string &v) const
 
- Public Member Functions inherited from base_properties
 base_properties (const std::string &ty="unknown", const graphics_handle &mh=graphics_handle(), const graphics_handle &p=graphics_handle())
 
virtual ~base_properties ()=default
 
virtual void add_listener (const caseless_str &, const octave_value &, listener_mode=GCB_POSTSET)
 
virtual void adopt (const graphics_handle &h)
 
std::set< std::string > all_property_names () const
 
bool busyaction_is (const std::string &v) const
 
virtual void delete_children (bool clear=false, bool from_root=false)
 
virtual void delete_listener (const caseless_str &, const octave_value &, listener_mode=GCB_POSTSET)
 
std::set< std::string > dynamic_property_names () const
 
void execute_buttondownfcn (const octave_value &new_data=octave_value()) const
 
void execute_createfcn (const octave_value &new_data=octave_value()) const
 
void execute_deletefcn (const octave_value &new_data=octave_value()) const
 
octave_value get___appdata__ () const
 
std::string get___modified__ () const
 
graphics_handle get___myhandle__ () const
 
Matrix get_all_children () const
 
std::string get_beingdeleted () const
 
virtual Matrix get_boundingbox (bool=false, const Matrix &=Matrix()) const
 
std::string get_busyaction () const
 
octave_value get_buttondownfcn () const
 
Matrix get_children () const
 
void get_children_of_type (const caseless_str &type, bool get_invisible, bool traverse, std::list< graphics_object > &children_list) const
 
std::string get_clipping () const
 
graphics_handle get_contextmenu () const
 
octave_value get_createfcn () const
 
octave_value get_deletefcn () const
 
std::string get_handlevisibility () const
 
Matrix get_hidden_children () const
 
std::string get_hittest () const
 
std::string get_interruptible () const
 
graphics_handle get_parent () const
 
std::string get_pickableparts () const
 
std::string get_selected () const
 
std::string get_selectionhighlight () const
 
std::string get_tag () const
 
virtual octave::graphics_toolkit get_toolkit () const
 
std::string get_type () const
 
graphics_handle get_uicontextmenu () const
 
octave_value get_userdata () const
 
std::string get_visible () const
 
virtual octave_value get_zlim () const
 
bool handlevisibility_is (const std::string &v) const
 
bool has_dynamic_property (const std::string &pname) const
 
virtual void init_integerhandle (const octave_value &)
 
void insert_property (const std::string &name, property p)
 
bool is___modified__ () const
 
bool is_beingdeleted () const
 
bool is_clipping () const
 
bool is_handle_visible () const
 
bool is_hittest () const
 
bool is_interruptible () const
 
bool is_modified () const
 
bool is_selected () const
 
bool is_selectionhighlight () const
 
bool is_visible () const
 
virtual bool is_zliminclude () const
 
void mark_modified ()
 
void override_defaults (base_graphics_object &obj)
 
bool pickableparts_is (const std::string &v) const
 
virtual void remove_child (const graphics_handle &h, bool=false)
 
void renumber_child (graphics_handle old_gh, graphics_handle new_gh)
 
void renumber_parent (graphics_handle new_gh)
 
void reparent (const graphics_handle &new_parent)
 
void set___appdata__ (const octave_value &val)
 
void set___modified__ (const octave_value &val)
 
void set_beingdeleted (const octave_value &val)
 
void set_busyaction (const octave_value &val)
 
void set_buttondownfcn (const octave_value &val)
 
void set_children (const octave_value &val)
 
void set_clipping (const octave_value &val)
 
void set_contextmenu (const octave_value &val)
 
void set_createfcn (const octave_value &val)
 
void set_deletefcn (const octave_value &val)
 
void set_from_list (base_graphics_object &obj, property_list &defaults)
 
void set_handlevisibility (const octave_value &val)
 
void set_hittest (const octave_value &val)
 
void set_interruptible (const octave_value &val)
 
void set_modified (const octave_value &val)
 
void set_parent (const octave_value &val)
 
void set_pickableparts (const octave_value &val)
 
void set_selected (const octave_value &val)
 
void set_selectionhighlight (const octave_value &val)
 
void set_tag (const octave_value &val)
 
void set_uicontextmenu (const octave_value &val)
 
void set_userdata (const octave_value &val)
 
void set_visible (const octave_value &val)
 
virtual void update_autopos (const std::string &elem_type)
 
virtual void update_axis_limits (const std::string &axis_type) const
 
virtual void update_axis_limits (const std::string &axis_type, const graphics_handle &h) const
 
virtual void update_beingdeleted ()
 
virtual void update_boundingbox ()
 
virtual void update_contextmenu () const
 
virtual void update_handlevisibility ()
 
virtual void update_visible ()
 

Static Public Member Functions

static std::set< std::string > core_property_names ()
 
static property_list::pval_map_type factory_defaults ()
 
static bool has_core_property (const caseless_str &pname)
 
static bool has_readonly_property (const caseless_str &pname)
 
static std::set< std::string > readonly_property_names ()
 
- Static Public Member Functions inherited from base_properties
static std::set< std::string > core_property_names ()
 
static property_list::pval_map_type factory_defaults ()
 
static bool has_core_property (const caseless_str &pname)
 
static bool has_readonly_property (const caseless_str &pname)
 
static std::set< std::string > readonly_property_names ()
 

Protected Member Functions

void init ()
 
- Protected Member Functions inherited from base_properties
octave_value get_dynamic (bool all=false) const
 
octave_value get_dynamic (const caseless_str &pname) const
 
property get_property_dynamic (const caseless_str &pname) const
 
void set_dynamic (const caseless_str &pname, const octave_value &val)
 

Additional Inherited Members

- Protected Attributes inherited from base_properties
any_property m___appdata__
 
bool_property m___modified__
 
graphics_handle m___myhandle__
 
std::map< caseless_str, property, cmp_caseless_strm_all_props
 
bool_property m_beingdeleted
 
radio_property m_busyaction
 
callback_property m_buttondownfcn
 
children_property m_children
 
bool_property m_clipping
 
handle_property m_contextmenu
 
callback_property m_createfcn
 
callback_property m_deletefcn
 
std::set< std::string > m_dynamic_properties
 
radio_property m_handlevisibility
 
bool_property m_hittest
 
bool_property m_interruptible
 
handle_property m_parent
 
radio_property m_pickableparts
 
bool_property m_selected
 
bool_property m_selectionhighlight
 
string_property m_tag
 
string_property m_type
 
handle_property m_uicontextmenu
 
any_property m_userdata
 
bool_property m_visible
 

Detailed Description

Definition at line 8367 of file graphics.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
ID_ALPHADATA 
ID_ALPHADATAMAPPING 
ID_CDATA 
ID_CDATAMAPPING 
ID_XDATA 
ID_YDATA 
ID_ALIM 
ID_CLIM 
ID_XLIM 
ID_YLIM 
ID_ALIMINCLUDE 
ID_CLIMINCLUDE 
ID_XLIMINCLUDE 
ID_YLIMINCLUDE 
ID_XDATAMODE 
ID_YDATAMODE 

Definition at line 8459 of file graphics.h.

Constructor & Destructor Documentation

◆ properties() [1/2]

image::properties::properties ( const graphics_handle mh,
const graphics_handle p 
)

Definition at line 4043 of file graphics-props.cc.

◆ properties() [2/2]

image::properties::properties ( )
delete

◆ ~properties()

image::properties::~properties ( )
default

Member Function Documentation

◆ all_property_names()

std::set< std::string > image::properties::all_property_names ( ) const

Definition at line 4359 of file graphics-props.cc.

References base_properties::all_property_names().

◆ alphadatamapping_is()

bool image::properties::alphadatamapping_is ( const std::string &  v) const
inline

Definition at line 8481 of file graphics.h.

References radio_property::is().

◆ cdatamapping_is()

bool image::properties::cdatamapping_is ( const std::string &  v) const
inline

Definition at line 8486 of file graphics.h.

References radio_property::is().

◆ core_property_names()

std::set< std::string > image::properties::core_property_names ( )
static

Definition at line 4285 of file graphics-props.cc.

References base_properties::core_property_names().

◆ factory_defaults()

property_list::pval_map_type image::properties::factory_defaults ( )
static

Definition at line 4258 of file graphics-props.cc.

References base_properties::factory_defaults(), and m.

◆ get() [1/4]

octave_value image::properties::get ( bool  all = false) const
virtual

Reimplemented from base_properties.

Definition at line 4133 of file graphics-props.cc.

References base_properties::get(), m, and octave_value::map_value().

◆ get() [2/4]

octave_value image::properties::get ( const caseless_str pname) const
virtual

Reimplemented from base_properties.

Definition at line 4168 of file graphics-props.cc.

◆ get() [3/4]

octave_value image::properties::get ( const char *  pname) const
inlinevirtual

Reimplemented from base_properties.

Definition at line 8409 of file graphics.h.

◆ get() [4/4]

octave_value image::properties::get ( const std::string &  pname) const
inlinevirtual

Reimplemented from base_properties.

Definition at line 8404 of file graphics.h.

◆ get_alim()

octave_value image::properties::get_alim ( ) const
inlinevirtual

Reimplemented from base_properties.

Definition at line 8493 of file graphics.h.

References array_property::get().

◆ get_aliminclude()

std::string image::properties::get_aliminclude ( ) const
inline

Definition at line 8373 of file graphics.h.

◆ get_alphadata()

octave_value image::properties::get_alphadata ( ) const
inline

Definition at line 8479 of file graphics.h.

References array_property::get().

◆ get_alphadatamapping()

std::string image::properties::get_alphadatamapping ( ) const
inline

Definition at line 8482 of file graphics.h.

References radio_property::current_value().

◆ get_cdata()

octave_value image::properties::get_cdata ( ) const
inline

Definition at line 8484 of file graphics.h.

References array_property::get().

◆ get_cdatamapping()

std::string image::properties::get_cdatamapping ( ) const
inline

Definition at line 8487 of file graphics.h.

References radio_property::current_value().

◆ get_clim()

octave_value image::properties::get_clim ( ) const
inlinevirtual

Reimplemented from base_properties.

Definition at line 8495 of file graphics.h.

References array_property::get().

◆ get_climinclude()

std::string image::properties::get_climinclude ( ) const
inline

Definition at line 8378 of file graphics.h.

◆ get_color_data()

octave_value image::properties::get_color_data ( ) const

Definition at line 9373 of file graphics.cc.

Referenced by opengl_renderer::draw_image().

◆ get_property()

property image::properties::get_property ( const caseless_str pname)
virtual

Reimplemented from base_properties.

Definition at line 4215 of file graphics-props.cc.

◆ get_xdata()

octave_value image::properties::get_xdata ( ) const
inline

Definition at line 8489 of file graphics.h.

References array_property::get().

Referenced by opengl_renderer::draw_image().

◆ get_xdatamode()

std::string image::properties::get_xdatamode ( ) const
inline

Definition at line 8508 of file graphics.h.

References radio_property::current_value().

◆ get_xlim()

octave_value image::properties::get_xlim ( ) const
inlinevirtual

Reimplemented from base_properties.

Definition at line 8497 of file graphics.h.

References array_property::get().

◆ get_xliminclude()

std::string image::properties::get_xliminclude ( ) const
inline

Definition at line 8502 of file graphics.h.

References radio_property::current_value().

◆ get_ydata()

octave_value image::properties::get_ydata ( ) const
inline

Definition at line 8491 of file graphics.h.

References array_property::get().

Referenced by opengl_renderer::draw_image().

◆ get_ydatamode()

std::string image::properties::get_ydatamode ( ) const
inline

Definition at line 8511 of file graphics.h.

References radio_property::current_value().

◆ get_ylim()

octave_value image::properties::get_ylim ( ) const
inlinevirtual

Reimplemented from base_properties.

Definition at line 8499 of file graphics.h.

References array_property::get().

◆ get_yliminclude()

std::string image::properties::get_yliminclude ( ) const
inline

Definition at line 8505 of file graphics.h.

References radio_property::current_value().

◆ graphics_object_name()

std::string image::properties::graphics_object_name ( ) const
inlinevirtual

Reimplemented from base_properties.

Definition at line 8416 of file graphics.h.

◆ has_core_property()

bool image::properties::has_core_property ( const caseless_str pname)
static

Definition at line 4320 of file graphics-props.cc.

Referenced by property_list::set().

◆ has_property()

bool image::properties::has_property ( const caseless_str pname) const
virtual

Reimplemented from base_properties.

Definition at line 4371 of file graphics-props.cc.

◆ has_readonly_property()

bool image::properties::has_readonly_property ( const caseless_str pname)
static

Definition at line 4351 of file graphics-props.cc.

◆ init()

void image::properties::init ( )
inlineprotectedvirtual

Reimplemented from base_properties.

Definition at line 8676 of file graphics.h.

References array_property::add_constraint(), and row_vector_property::add_constraint().

◆ initialize_data()

void image::properties::initialize_data ( )
inline

Definition at line 8383 of file graphics.h.

◆ is_aliminclude()

bool image::properties::is_aliminclude ( ) const
inlinevirtual

Reimplemented from base_properties.

Definition at line 8371 of file graphics.h.

◆ is_climinclude()

bool image::properties::is_climinclude ( ) const
inlinevirtual

Reimplemented from base_properties.

Definition at line 8376 of file graphics.h.

◆ is_xliminclude()

bool image::properties::is_xliminclude ( ) const
inlinevirtual

Reimplemented from base_properties.

Definition at line 8501 of file graphics.h.

References bool_property::is_on().

◆ is_yliminclude()

bool image::properties::is_yliminclude ( ) const
inlinevirtual

Reimplemented from base_properties.

Definition at line 8504 of file graphics.h.

References bool_property::is_on().

◆ pixel_xsize()

float image::properties::pixel_xsize ( )
inline

Definition at line 8804 of file graphics.h.

References array_property::get_limits().

Referenced by F__image_pixel_size__().

◆ pixel_ysize()

float image::properties::pixel_ysize ( )
inline

Definition at line 8809 of file graphics.h.

References array_property::get_limits().

Referenced by F__image_pixel_size__().

◆ readonly_property_names()

std::set< std::string > image::properties::readonly_property_names ( )
static

Definition at line 4328 of file graphics-props.cc.

References base_properties::readonly_property_names().

◆ set()

void image::properties::set ( const caseless_str pname,
const octave_value val 
)
virtual

Reimplemented from base_properties.

Definition at line 4092 of file graphics-props.cc.

◆ set_alim()

void image::properties::set_alim ( const octave_value val)
inline

Definition at line 8578 of file graphics.h.

References GCB_POSTSET, base_property::run_listeners(), and base_property::set().

◆ set_aliminclude()

void image::properties::set_aliminclude ( const octave_value val)
inline

Definition at line 8618 of file graphics.h.

References GCB_POSTSET, base_property::run_listeners(), and base_property::set().

◆ set_alphadata()

void image::properties::set_alphadata ( const octave_value val)
inline

Definition at line 8514 of file graphics.h.

References base_property::set().

◆ set_alphadatamapping()

void image::properties::set_alphadatamapping ( const octave_value val)
inline

Definition at line 8523 of file graphics.h.

References GCB_POSTSET, base_property::run_listeners(), and base_property::set().

◆ set_cdata()

void image::properties::set_cdata ( const octave_value val)
inline

Definition at line 8533 of file graphics.h.

References base_property::set().

◆ set_cdatamapping()

void image::properties::set_cdatamapping ( const octave_value val)
inline

Definition at line 8542 of file graphics.h.

References GCB_POSTSET, base_property::run_listeners(), and base_property::set().

◆ set_clim()

void image::properties::set_clim ( const octave_value val)
inline

Definition at line 8588 of file graphics.h.

References GCB_POSTSET, base_property::run_listeners(), and base_property::set().

◆ set_climinclude()

void image::properties::set_climinclude ( const octave_value val)
inline

Definition at line 8628 of file graphics.h.

References GCB_POSTSET, base_property::run_listeners(), and base_property::set().

◆ set_xdata()

void image::properties::set_xdata ( const octave_value val)
inline

Definition at line 8552 of file graphics.h.

References GCB_POSTSET, base_property::run_listeners(), and base_property::set().

◆ set_xdatamode()

void image::properties::set_xdatamode ( const octave_value val)
inline

Definition at line 8658 of file graphics.h.

References base_property::set().

◆ set_xlim()

void image::properties::set_xlim ( const octave_value val)
inline

Definition at line 8598 of file graphics.h.

References GCB_POSTSET, base_property::run_listeners(), and base_property::set().

◆ set_xliminclude()

void image::properties::set_xliminclude ( const octave_value val)
inline

Definition at line 8638 of file graphics.h.

References GCB_POSTSET, base_property::run_listeners(), and base_property::set().

◆ set_ydata()

void image::properties::set_ydata ( const octave_value val)
inline

Definition at line 8565 of file graphics.h.

References GCB_POSTSET, base_property::run_listeners(), and base_property::set().

◆ set_ydatamode()

void image::properties::set_ydatamode ( const octave_value val)
inline

Definition at line 8666 of file graphics.h.

References base_property::set().

◆ set_ylim()

void image::properties::set_ylim ( const octave_value val)
inline

Definition at line 8608 of file graphics.h.

References GCB_POSTSET, base_property::run_listeners(), and base_property::set().

◆ set_yliminclude()

void image::properties::set_yliminclude ( const octave_value val)
inline

Definition at line 8648 of file graphics.h.

References GCB_POSTSET, base_property::run_listeners(), and base_property::set().

◆ xdatamode_is()

bool image::properties::xdatamode_is ( const std::string &  v) const
inline

Definition at line 8507 of file graphics.h.

References radio_property::is().

◆ ydatamode_is()

bool image::properties::ydatamode_is ( const std::string &  v) const
inline

Definition at line 8510 of file graphics.h.

References radio_property::is().


The documentation for this class was generated from the following files: