emergent 8.2.2 NetView Class Reference
emergent 8.2.2   Home · Wiki Docs For: NetView · Emergent Help Browser 

NetView Class Reference

network view main object -- represents the network in view, manages all sub-types

See for more info: Wiki Docs For: NetView

 #include <NetView>

defined at: /mnt/ssd/grey/local/include/Emergent/NetView.h :108-344

Inherits From: T3DataViewMain, T3DataViewPar, T3DataView, taDataView, taNBase, taOBase, taBase, ISigLinkClient, ISigLinkProxy, ITypedObject, IObjectSelectable, ISelectable

Inherited By: NetView*, NetView&, const NetView

Index: SubTypes, Members, Methods, Static Members, Static Methods, Expert Members, Expert Methods

Sub Types


SubType Documentation

enum taDataView::DataViewAction

enum used to (safely) manually invoke one or more _impl actions

ConstantValueDescription
taDataView::CONSTR_POST0x00000001(only used by taViewer)
taDataView::CLEAR_IMPL0x00000002(only used by T3DataView)
taDataView::RENDER_PRE0x00000004
taDataView::RENDER_IMPL0x00000008
taDataView::RENDER_POST0x00000010
taDataView::CLOSE_WIN_IMPL0x00000020(only used by taViewer)
taDataView::RESET_IMPL0x00000040
taDataView::UNBIND_IMPL0x00000080disconnect everyone from a data source
taDataView::SHOWING_IMPL0x00000100
taDataView::HIDING_IMPL0x00000200

enum ISelectable::GuiContext

primarily for the T3 guys that have dual identities (don't reorder these)

ConstantValueDescription
ISelectable::GC_DEFAULT0x00000000this code only used when requesting the default link
ISelectable::GC_SINGLE_DATA0x00000001for trees, etc., only one identity, and link() is data
ISelectable::GC_DUAL_DEF_DATA0x00000002for T3, guys like Layer, where def identity is the data
ISelectable::GC_DUAL_DEF_VIEW0x00000003for T3, guys like GraphView, where def ident is the graphview obj itself

enum T3DataView::DataNodeFlags

TODO: following copied from browsing; will need to be modified

ConstantValueDescription
T3DataView::DNF_IS_FOLDER0x00000001true for list/group folder nodes (note: does *not* indicate whether item can contain other things or not)
T3DataView::DNF_IS_ALIAS0x00000002true after children have been created (after clicking on node)
T3DataView::DNF_UPDATE_NAME0x00000004typically for list items, update the visual name (tree, tab, etc.) after item edited
T3DataView::DNF_CAN_BROWSE0x00000008can be a new browser root
T3DataView::DNF_CAN_DRAG0x0000001016 can allow drags
T3DataView::DNF_NO_CAN_DROP0x0000002032 cannot accept drops
T3DataView::DNF_IS_MEMBER0x0000004064 true for members (and root), not for list/group items -- helps node configure edit ops
T3DataView::DNF_IS_LIST_NODE0x00000080true for nodes in a list view (in panel, not on tree)

enum T3DataViewMain::TextJust

justification for text

ConstantValueDescription
T3DataViewMain::LEFT0x00000000left justified text
T3DataViewMain::CENTER0x00000001center justified text
T3DataViewMain::RIGHT0x00000002right justified text

enum NetView::MDFlags

indicates type that unit.disp_base points to

ConstantValueDescription
NetView::MD_FLOAT0x00000000
NetView::MD_DOUBLE0x00000001
NetView::MD_INT0x00000002
NetView::MD_UNKNOWN0x0000000F

enum NetView::UnitTextDisplay

how to display unit text

ConstantValueDescription
NetView::UTD_NONE0x00000000no text (default)
NetView::UTD_VALUES0x00000001unit values only
NetView::UTD_NAMES0x00000002unit names only
NetView::UTD_BOTH0x00000003both unit values and names

enum NetView::UnitDisplayMode

ConstantValueDescription
NetView::UDM_CIRCLE0x00000000just color, no 3d -- best for when displaying labels
NetView::UDM_RECT0x00000001just color, no 3d -- best for when displaying labels
NetView::UDM_BLOCK0x00000002
NetView::UDM_CYLINDER0x00000003

enum NetView::LayerLayout

Visual mode of layer position/view

ConstantValueDescription
NetView::TWO_D0x00000000all z = 0, no skew
NetView::THREE_D0x00000001z = layer index, default skew

enum NetView::ConType

where there are multiple types of connections between units, this allows selection of which type to display

ConstantValueDescription
NetView::ANY_CON0x00000000just show the first connection shown -- don't select by name at all
NetView::STD_CON0x00000001only show standard connections -- projection names start with Fm_
NetView::INHIB_CON0x00000002only show inhib connections -- projection names start with Inhib_
NetView::CTXT_CON0x00000003only show context connections -- projection names start with Ctxt_
NetView::DEEP_CON0x00000004only show deep connections -- projection names start with Deep_
NetView::MARKER_CON0x00000005only show MarkerConSpec connections -- projection names start with Marker_


Regular (preferred) Member and Method Documentation

Members

Member Category: _NoCategory

Member Category: taBase

Methods

Method Category: Access

Method Category: ControlPanel

Method Category: Display

Method Category: File

Method Category: ListMgmt

Method Category: ObjectMgmt

Method Category: UserData

Method Category: _NoCategory


Member Documentation

Member Category: _NoCategory

T3DataViewMain::annote_children : T3DataView_List

annotation view children -- keep separate from other kids so they don't interfere

T3DataViewPar::children : T3DataView_List

child view objects

NetView::con_type : NetView::ConType

what type of connections should be shown (where there are multiple connections between two units)

taDataView::cur_font_size : int

Can be used by viewers to set/save a font size that is specific to the viewer

NetView::display : bool

whether to update the display when values change (under control of programs)

NetView::font_sizes : NetViewFontSizes

font sizes for various items

NetView::hist_ff : int

how many steps to take in the fast forward/ fast backward interface

NetView::hist_max : int

how much history of state information to store -- updated each time UpdateUnitValues is called

NetView::hist_save : bool

whether to save history right now or not -- can slow things down so need quick option to turn off

NetView::hot_vars : String_Array

current 'hot' variables shown directly in explorer view

NetView::last_sel_unit_val : taString

value of last selected unit (for display)

NetView::lay_layout : NetView::LayerLayout

how to display layers -- 2d or 3d

NetView::lay_mv : bool

whether to display layer move controls when the arrow button is pressed (can get in the way of viewing weights)

T3DataViewMain::main_xform : taTransform

this is the overall transform (position, scale, rotation) for this view object (typically can be adjusted by view's transform dragbox)

NetView::movie_size : PosVector2i

size of movie frame to save for Movie button in netview

NetView::net_text : bool

whether to display text box below network with counters etc

NetView::net_text_rot : float

rotation of the text in the Z plane (in degrees) - default is upright, but if text area is rotated, then a different angle might work better

NetView::net_text_xform : taTransform

transform of coordinate system for the net text display element

NetView::scale : ColorScale

contains current min,max,range,zero,auto_scale

NetView::show_iconified : bool

show iconified layers -- otherwise they are removed entirely

NetView::snap_bord_disp : bool

display snapshot value snap as a border around units

NetView::snap_bord_width : float

width of snapshot border lines

NetView::unit_disp_mode : NetView::UnitDisplayMode

how to display unit values

NetView::unit_text_disp : NetView::UnitTextDisplay

what labels to display with units

NetView::view_params : NetViewParams

misc view parameters

NetView::wt_line_disp : bool

display weights from selected unit as lines?

NetView::wt_line_swt : bool

plot sending weights instead of recv weights

NetView::wt_line_thr : float

threshold on fabs(wt) value -- don't display below this value

NetView::wt_line_width : float

width of weight lines

NetView::wt_prjn_k_gp : float

number of top-k unit groups to project weights through

NetView::wt_prjn_k_un : float

number of top-k units to project weights through

NetView::wt_prjn_lay : LayerRef

layer to display projected weights for

Member Category: taBase

taNBase::name : taString

name of the object


Method Documentation

Method Category: Access

Variant T3DataView::Elem ( Variant& idx, taBase::IndexMode mode = IDX_UNK )

get element(s) from container -- return can be a single item or a Matrix of multiple items, depending on the index -- see IndexMode for all the possible indexing modes and associated return values (some of which are not applicable to some containers, as documented for that container)

Show Source Code

taBase* T3DataView::ElemPath ( taString& path, TypeDef* expect_type = __null, bool err_msg = true )

returns taBase item at given path under this object -- path can skip over steps -- a search is conducted to find items -- this provides the same kind of flexibility that css provides in accessing elements of the structural hierarchy -- also allows for type checking of result -- it is just a wrapper around FindFromPath with optional error checking

Show Source Code

bool T3DataView::IsContainer ( )

is this item a container object or not?

Show Source Code

int T3DataView::IterCount ( )

how many items will be iterated over if we iterate through this container -- this is fast for no view and IDX_COORDS views and slow (requiring summing over mask) for IDX_MASK views

Show Source Code

Variant T3DataView::IterFirst ( taBaseItr& itr )

get iterator for this container and start it at the first item for iterating through items in this container -- if no valid first item, iterator is deleted: e.g., taBaseItr itr; for(Variant itm = cont.IterFirst(itr); itr.More(); itm = cont.IterNext(itr)) { ... } -- see also TA_FOREACH macro

Show Source Code

int T3DataView::IterFirstIndex ( taBaseItr& itr )

get iterator for this container and start index at the first item for iterating through items in this container, returns index if iterator was set to a valid index, -1 if not, in which case iterator is deleted: e.g., taBaseItr itr; for(Variant itm = cont.IterFirstIndex(itr); itr.More(); itm = cont.IterNextIndex(itr)) { ... } -- see also TA_FOREACH_INDEX macro

Show Source Code

Variant T3DataView::IterLast ( taBaseItr& itr )

get reverse iterator for this container and start it at the last item for iterating through items in this container -- if no valid last item, iterator is deleted: e.g., taBaseItr itr; for(Variant itm = cont.IterLast(itr); itr.More(); itm = cont.IterNextRev(itr)) { ... } -- see also TA_FOREACH_REV macro

Show Source Code

int T3DataView::IterLastIndex ( taBaseItr& itr )

get iterator for this container and start index at the last item for iterating through items in this container in reverse, returns index if iterator was set to a valid index, -1 if not, in which case iterator is deleted: e.g., taBaseItr itr; for(Variant itm = cont.IterLastIndex(itr); itr.More(); itm = cont.IterPrevIndex(itr)) { ... } -- see also TA_FOREACH_INDEX_REV macro

Show Source Code

Variant T3DataView::IterNext ( taBaseItr& itr )

iterate to next item in container using given iterator -- when the end is reached, the iterator pointer is automatically deleted and the pointer is set to NULL (and returns _nilVariant) -- use itr as test to see if there is a next item -- see IterFirst() for more docs

Show Source Code

int T3DataView::IterNextIndex ( taBaseItr& itr )

iterate to index of next item in container using given iterator -- when the end is reached, the iterator pointer is automatically deleted and the pointer is set to NULL (and returns _nilVariant) -- use itr as test to see if there is a next item -- see IterFirstIndex() for more docs

Show Source Code

Variant T3DataView::IterPrev ( taBaseItr& itr )

iterate to previous item in container using given iterator -- when the end is reached, the iterator pointer is automatically deleted and the pointer is set to NULL (and returns _nilVariant) -- use itr as test to see if there is a prev item -- see IterLast() for more docs

Show Source Code

int T3DataView::IterPrevIndex ( taBaseItr& itr )

iterate to index of previous item in container using given iterator -- when the end is reached, the iterator pointer is automatically deleted and the pointer is set to NULL (and returns _nilVariant) -- use itr as test to see if there is a prev item -- see IterLastIndex() for more docs

Show Source Code

Method Category: ControlPanel

bool T3DataView::AddFunToControlPanel ( MethodDef* function, ControlPanel* ctrl_panel, taString& extra_label )

select a function (method) for calling from a project control_panel - a panel that is a user chosen collection of members and methods from one or more objects (if ctrl_panel is NULL, a new one is created in .ctrl_panels). returns false if method was already selected. extra_label is prepended to function name if present

Show Source Code

bool T3DataView::AddFunToControlPanelNm ( taString& function_nm, ControlPanel* ctrl_panel, taString& extra_label = taString(), taString& sub_gp_nm = taString(), taString& desc = taString() )

select a method (by name) for use in a control_panel that is a collection of selected members and methods from different objects (if ctrl_panel is NULL, a new one is created in .crtl_panels) returns false if method was already selected. desc is a custom description -- will show up as tooltip for user (default is info from method)

Show Source Code

bool T3DataView::AddToControlPanel ( MemberDef* member, ControlPanel* ctrl_panel )

select an object member to be added to a given control_panel (a user-chosen collection of members and methods from one or more objects -- if ctrl_panel is NULL, a new one is created in .ctrl_panels). returns false if member was already selected. prompts user for final specification of label to use

Show Source Code

bool T3DataView::AddToControlPanelNm ( taString& memb_nm, ControlPanel* ctrl_panel, taString& extra_label = taString(), taString& sub_gp_nm = taString(), taString& desc = taString(), bool short_label = false )

add given member (by name) given control_panel (a user-chosen collection of members and methods from one or more objects -- if ctrl_panel is NULL, a new one is created in .ctrl_panels). returns false if member was already selected. extra_label is prepended to member name if present, otherwise owner obj name and path to member is prepended, and if sub_gp_nm is specified, item will be put in this sub-group (new one will be made if it does not yet exist). desc is a custom description -- will show up as tooltip for user (default is info from member). short_label omits prepending owner name to label

Show Source Code

ControlPanel* T3DataView::MemberControlPanel ( taString& member_name, TypeDef* panel_type = __null )

if a given member name (must be direct member of object) is on a control panel, this returns the first such control panel that it is on, else NULL -- if panel_type is non-null, it ONLY looks for panels of a given type (e.g., ParamSet, etc) -- otherwise looks for any kind of ControlPanel (excluding archives -- only active)

Show Source Code

Method Category: Display

void T3DataView::BrowseMe ( )

show this object in its own browser

Show Source Code

bool T3DataView::BrowserCollapseAll ( )

collapse all sub-leaves under this item in the browser

Show Source Code

bool T3DataView::BrowserEditMe ( )

select this item and open for edit (only works if gui is active, etc) -- returns success

Show Source Code

bool T3DataView::BrowserExpandAll ( )

expand all sub-leaves under this item in the browser

Show Source Code

bool T3DataView::BrowserSelectMe ( )

select this item in the main project browser (only works if gui is active, etc) -- returns success

Show Source Code

bool T3DataView::ChooseMe ( )

Display a chooser of whatever type this method is called on

Show Source Code

taString T3DataView::DiffCompareString ( taBase* cmp_obj, taDoc*& doc )

compare this object with selected comparison object using a diff operation on their save file representations -- more robust to large differences than the select-for-edit version (if doc is NULL, a new one is created in .docs). returns diff string as well.

Show Source Code

bool T3DataView::Edit ( )

Edit this object using the gui -- this will be an edit dialog or an edit panel depending on ...???

Show Source Code

bool T3DataView::EditPanel ( bool new_tab = false, bool pin_tab = false )

Edit this object in a panel in the gui browser (if new_tab == true, then a new edit panel tab is opened for it, if pin_tab == true then the new tab is pinned in place (option ignored for new_tab == false))

Show Source Code

MainWindowViewer* T3DataView::GetMyBrowser ( )

get the project browser for this object's project owner

Show Source Code

bool T3DataView::GuiFindFromMe ( taString& find_str )

activate the gui find dialog starting from this object, with given find string

Show Source Code

void T3DataView::Help ( )

get help on using this object

Show Source Code

bool T3DataView::OpenInWindow ( bool modal = false )

Edit this object in a popup dialog using the gui (if modal == true, the edit dialog blocks all other gui operations until the user closes it)

Show Source Code

taString& T3DataView::Print ( taString& strm, int indent = 0 )

print the value of the object to given string

Show Source Code

taString T3DataView::PrintStr ( int indent = 0 )

print the value of the object to a string

Show Source Code

void T3DataView::RebuildAllViews ( )

call after data changes, to rebuild views, typically when a child is added

Show Source Code

void T3DataView::UpdateAllViews ( )

called after data changes, to update views

Show Source Code

Method Category: File

taString T3DataView::GetFileName ( )

get file name object was last saved with

Show Source Code

taString T3DataView::GetFileNameFmProject ( taString& ext, taString& tag, taString& subdir, bool dmem_proc_no = false )

get file name from project file name -- useful for saving files associated with the project; ext = extension; tag = additional tag; subdir = additional directory after any existing in project name; fname = proj->base_name (subdir) + tag + ext; if dmem_proc_no, add dmem proc no to file name. empty if project not found

Show Source Code

taString T3DataView::GetProjDir ( )

get the directory path associated with the project that this object lives within

Show Source Code

int T3DataView::Load ( taString& fname, taBase** loaded_obj_ptr = __null )

Load object data from given file name (if empty, prompt user for a name) -- sets pointer to loaded obj if non-null: could actually load a different object than this (e.g. if this is a list or group)

Show Source Code

int T3DataView::Save ( )

saves the object to a file using current file name

Show Source Code

int T3DataView::SaveAs ( taString& fname )

Saves object data to a new file -- if fname is empty, the user is prompted with a file dialog

Show Source Code

bool T3DataView::SetFileName ( taString& val )

set file name for object

Show Source Code

Method Category: ListMgmt

taBase* T3DataView::CopyChildBefore ( taBase* src, taBase* child_pos )

implemented by container (list) objects: make a copy of the src object and insert it at the position of the child_pos object within this list -- copies the name of the object too

Show Source Code

taBase* T3DataView::CopyChildBeforeIndex ( taBase* src, int child_pos )

implemented by container (list) objects: make a copy of the src object and insert it at the position of the child_pos object within this list -- copies the name of the object too

Show Source Code

Method Category: ObjectMgmt

void T3DataView::CallFun ( taString& fun_name, taString& args_str )

call function (method) of given name on this object, using args as comma-separated simple literal expressions for argument values, or prompting for args using gui interface otherwise if needed

Show Source Code

void T3DataView::ChangeBaseFlag ( int flag, bool set )

sets or clears the flag(s)

Show Source Code

bool T3DataView::ChangeMyType ( TypeDef* new_type )

Change me into a different type of object, copying current info (done through owner)

Show Source Code

bool T3DataView::CheckConfig ( bool quiet = false )

check the configuration of this object and all its children (defaults to no confirm of success)

Show Source Code

bool T3DataView::CheckConfig_Gui ( bool confirm_success = true, bool quiet = false )

check the configuration of this object and all its children -- failed items highlighted in red, items with failed children in yellow

Show Source Code

bool T3DataView::CheckError ( bool test, bool quiet, bool& rval, taString& a, taString& b, taString& c, taString& d, taString& e, taString& f, taString& g, taString& h )

for CheckConfig routines: if test, then report config error, including object name, type, and path information; returns test & sets rval to false if test is true -- use e.g. CheckError((condition), quiet, rval, 'msg'));

Show Source Code

void T3DataView::ClearBaseFlag ( int flag )

clears the flag(s)

Show Source Code

void T3DataView::CloseLater ( )

PERMANENTLY Destroy this object! This is not Iconify or close window..

Show Source Code

bool T3DataView::CopyFrom ( taBase* cpy_from )

Copy from given object into this object (this is a safe interface to UnSafeCopy)

Show Source Code

bool T3DataView::CopyTo ( taBase* cpy_to )

Copy to given object from this object

Show Source Code

void T3DataView::DataUpdate ( bool begin )

bracket data value changes with (nestable) true/false calls;

Show Source Code

void T3DataView::DebugInfo ( taString& fun_name, taString& a, taString& b, taString& c, taString& d, taString& e, taString& f, taString& g, taString& h )

reports object identity in addition to the error message -- use this for any debug messages that get logged in reference to this object

Show Source Code

bool T3DataView::DerivesFromName ( taString& nm )

does this derive from given type name?

Show Source Code

bool T3DataView::DiffCompare ( taBase* cmp_obj )

compare this object with selected comparison object using a structured hierarchical diff operation -- pulls up a diff editor display to allow the user to view and merge the differences between objects

Show Source Code

taString T3DataView::DisplayPath ( )

get the path to this object for display purposes -- uses GetPathNames -- if under a program then that is used as starting point, otherwise returns a project relative path using GetPathFromProj -- other special cases may optimize as needed

Show Source Code

taBase* T3DataView::DuplicateMe ( )

Make another copy of myself (done through owner)

Show Source Code

taBase* T3DataView::FindFromPath ( taString& path, MemberDef*& ret_md, int start = 0 )

find object from path (starting from this object), and position to start (in characters) in the path string -- ret_md is return member def: if NULL and return is !NULL, then it is a member of a list or group, not a member in object

Show Source Code

void* T3DataView::FindMembeR ( taString& nm, MemberDef*& ret_md )

find member based on name or type, recursive -- does breadth-first then depth search -- returns pointer of member item, and ret_md is filled in if avail -- if NULL it indicates that it is an item in a list of type taBase and not a proper member

Show Source Code

taString T3DataView::GetEnumString ( taString& enum_tp_nm, int enum_val )

get the name corresponding to given enum value in enum type enum_tp_nm

Show Source Code

int T3DataView::GetEnumVal ( taString& enum_nm, taString& enum_tp_nm )

get the enum value corresponding to the given enum name (-1 if not found), and sets enum_tp_nm to name of type this enum belongs in (empty if not found)

Show Source Code

int T3DataView::GetIndex ( )

object's index within an owner list. cached by some objs.

Show Source Code

taBase* T3DataView::GetMemberOwner ( bool highest = false )

get the object that owns this object as a member -- if this object is not a member of its Owner (or has no owner) then it returns NULL -- if highest then it proceeds recursively up to the highest member owner and returns that -- i.e., if this is a member of a member (which is an object) of larger object, this will return the largest such object that contains this as a member at some level

Show Source Code

taString T3DataView::GetMemberStrVal ( taString& member )

get a string representation of the current value of given member of this object -- member_name can be a sub-path as well to a value within a member class

Show Source Code

taProject* T3DataView::GetMyProj ( )

get the project object that owns this object

Show Source Code

taString T3DataView::GetName ( )

Get the name of the object

Show Source Code

taBase* T3DataView::GetParent ( )

typically the first non-list/group owner above this one

Show Source Code

taString T3DataView::GetPath ( taBase* par_stop = __null )

get path without name information, stop at parent given by par_stop if non-null (resulting path will NOT include the parent info -- it will start with a . and be findable from that parent using FindFromPath)

Show Source Code

taString T3DataView::GetPathFromProj ( )

call GetPathNames relative to owning project -- this is the best path to use for saving and setting paths within a project -- tabMisc::RootFindFromPath can use these project-relative paths in conjunction with the current project to find the relevant objects -- is robust to renaming of the project

Show Source Code

taString T3DataView::GetPathNames ( taBase* par_stop = __null )

get paths using string names instead of indexes, which is good for portability, stop at parent given by par_stop if non-null (resulting path will NOT include the parent info -- it will start with a . and be findable from that parent using FindFromPath)

Show Source Code

Variant T3DataView::GetValFromPath ( taString& path, MemberDef*& ret_md, bool warn_not_found = false )

get a member value from given path -- only follows direct members (of members) of this object -- does not look into items in lists or groups

Show Source Code

bool T3DataView::HasBaseFlag ( int flag )

true if flag set, or if multiple, any set

Show Source Code

bool T3DataView::HasName ( )

does the object have a name field that can be set?

Show Source Code

bool T3DataView::InStructUpdate ( )

is object currently within a struct update already?

Show Source Code

bool T3DataView::InheritsFrom ( TypeDef* it )

does this inherit from given type

Show Source Code

bool T3DataView::InheritsFromName ( taString& nm )

does this inherit from given type name?

Show Source Code

bool T3DataView::IsChildOf ( taBase* obj )

true if this object is a direct or indirect child of the obj (or is the obj)

Show Source Code

bool T3DataView::IsParentOf ( taBase* obj )

true if this object is a direct or indirect parent of the obj (or is the obj)

Show Source Code

taString& T3DataView::ListSigClients ( taString& strm, int indent = 0 )

list all the data clients for this object to string

Show Source Code

void T3DataView::MakeNameUnique ( )

make sure my name is unique relative to names of objects associated with my owner (e.g., if it is a list object), typically because my name has changed, and owner needs to ensure that all names are unique

Show Source Code

void T3DataView::OwnTempObj ( )

call own on this object with tabMisc::root as the owner -- this is important for temporary objects that don't otherwise live within the main structural hierarchy -- especially for DataTables, objects may not behave properly without being Own'd, as this then sets the owner pointers within the temporary object and calls InitLinks

Show Source Code

void T3DataView::PrintMyPath ( )

print out the path to this object to the css console -- can then be copied for use in a program or other such things

Show Source Code

void T3DataView::Search ( taString& srch, taBase_PtrList& items, taBase_PtrList* owners = __null, bool text_only = true, bool contains = true, bool case_sensitive = false, bool obj_name = true, bool obj_type = true, bool obj_desc = true, bool obj_val = true, bool mbr_name = true, bool type_desc = false )

search for objects using srch string (which is split by whitespace into separate terms if applicable -- all terms must match), from this point down the structural hierarchy (my members, and their members and objects in lists, etc). items are linked into items list, and all owners of items found are linked into owners list (if present -- can be used as a lookup table for expanding owners to browse found items). contains = use 'contains' for all matches instead of exact match, rest are values to search in (obj_desc includes DisplayName as well as any explicit description), obj_val is only for value members and inline members

Show Source Code

void T3DataView::SetBaseFlag ( int flag )

sets the flag(s)

Show Source Code

void T3DataView::SetMember ( taString& member, taString& value )

Set member to value for each of the selected objects. Member will be the member name or will be object_name.member_name, e.g. input_size.retina_size.x, replace any space with '_'

Show Source Code

bool T3DataView::SetName ( taString& nm )

Set the object's name

Show Source Code

void T3DataView::SigEmitUpdated ( )

send the ITEM_UPDATED data changed signal to indicate to gui elements etc that this item has been updated

Show Source Code

void T3DataView::StructUpdate ( bool begin )

bracket structural changes with (nestable) true/false calls;

Show Source Code

void T3DataView::UpdateAfterEdit ( )

(aka UAE) called after editing, or any user change to members (eg. in the interface, script)

Show Source Code

void T3DataView::UpdateAfterEdit_NoGui ( )

does any object-related updates based on changes, but does NOT trigger any gui updates -- use this for updating members inside of an object's UAE

Show Source Code

void T3DataView::UpdateAll ( )

call UpdateAfterEdit on this object and all of its members and sub-objects, recursively, unless the class has the NO_UPDATE_AFTER flag set

Show Source Code

void T3DataView::setDirty ( bool value )

set the dirty flag indicating a change in object values; 'true' gets forwarded up; 'false' does nothing

Show Source Code

void T3DataView::setStale ( )

set the stale flag indicating a change in object values; gets forwarded up ('true' is implied, only the impl obj defines when it is cleared)

Show Source Code

Method Category: UserData

void T3DataView::CopyUserData ( taBase& cp )

copy our user data from the user data on another object (replaces any of our existing user data with the copy)

Show Source Code

const Variant T3DataView::GetUserData ( taString& key )

get specified user data; returns class default value if not present, or nilVariant if no default user data or class doesn't support UserData

Show Source Code

bool T3DataView::HasUserData ( taString& key )

returns true if UserData exists for this key (case sens)

Show Source Code

void T3DataView::RemoveAllUserData ( )

get rid of our user data list entirely -- this is done automatically when saving something that has no user data items, but you can also force it with this method -- deletes the whole list

Show Source Code

bool T3DataView::RemoveUserData ( taString& key )

removes data for indicated key; returns true if it existed

Show Source Code

void T3DataView::SetDocLink ( taDoc* doc )

set a link to a doc from the .docs collection -- the doc will then show up automatically in a panel for this obj -- set to NULL to remove it

Show Source Code

UserDataItem* T3DataView::SetUserData ( taString& key, Variant& value, bool gui_notify_signal = true )

make new (or change existing) simple user data entry with given name and value; returns item, which can be ignored -- emits a gui notification signal which can be suppressed if needed for speed or other reasons

Show Source Code

void T3DataView::SetUserData_Gui ( taString& key, Variant& value, taString& desc )

make new (or change existing) simple user data entry with given name and value (desc optional) -- this is how to get User Data editor panel to show up the first time

Show Source Code

Method Category: _NoCategory

bool T3DataView::AddFromTemplate ( taBase* obj, bool& is_acceptable )

handles drops from toolbar - when adding an object to a program, network, etc - e.g. dropping generic data table onto a program - set is_acceptable for objects 'not handled' but which are acceptable

Show Source Code

T3Annotation* T3DataViewMain::AnnoteCircle ( bool data_units, float ctr_x, float ctr_y, float ctr_z, float radius = 0.25, float line_width = 1.0, taString& color = black, bool fill = false, taString& fill_color = white )

add a circle annotation -- coordinates are in the normalized coordinates of the view (typically 1x1x1) or if data_units = true, in natural data units of the view (e.g., for a graph, the units of the data being graphed) (parameters converted to ellipse bounding box)

Show Source Code

void T3DataViewMain::AnnoteClearAll ( )

remove all existing annotations

Show Source Code

T3Annotation* T3DataViewMain::AnnoteDoubleArrow ( bool data_units, float pos_x, float pos_y, float pos_z, float size_x = 0.5, float size_y = 0.0, float size_z = 0.0, float line_width = 1.0, taString& color = black, float arrow_size = 0.02 )

add a double-arrow annotation -- coordinates are in the normalized coordinates of the view (typically 1x1x1) or if data_units = true, in natural data units of the view (e.g., for a graph, the units of the data being graphed)

Show Source Code

T3Annotation* T3DataViewMain::AnnoteEllipse ( bool data_units, float pos_x, float pos_y, float pos_z, float size_x = 0.5, float size_y = 0.5, float size_z = 0.0, float line_width = 1.0, taString& color = black, bool fill = false, taString& fill_color = white )

add an ellipse annotation -- coordinates are in the normalized coordinates of the view (typically 1x1x1) or if data_units = true, in natural data units of the view (e.g., for a graph, the units of the data being graphed), and define the bounding box for the ellipse

Show Source Code

T3Annotation* T3DataViewMain::AnnoteEndArrow ( bool data_units, float pos_x, float pos_y, float pos_z, float size_x = 0.5, float size_y = 0.0, float size_z = 0.0, float line_width = 1.0, taString& color = black, float arrow_size = 0.02 )

add a line with an ending arrow annotation -- coordinates are in the normalized coordinates of the view (typically 1x1x1) or if data_units = true, in natural data units of the view (e.g., for a graph, the units of the data being graphed)

Show Source Code

T3Annotation* T3DataViewMain::AnnoteLine ( bool data_units, float pos_x, float pos_y, float pos_z, float size_x = 0.5, float size_y = 0.0, float size_z = 0.0, float line_width = 1.0, taString& color = black )

add a line annotation -- coordinates are in the normalized coordinates of the view (typically 1x1x1) or if data_units = true, in natural data units of the view (e.g., for a graph, the units of the data being graphed)

Show Source Code

T3Annotation* T3DataViewMain::AnnoteObject ( bool data_units, taString& obj_file_path, float pos_x, float pos_y, float pos_z, taString& color = black )

add an object (3D inventor file) annotation -- coordinates are in the normalized coordinates of the view (typically 1x1x1) or if data_units = true, in natural data units of the view (e.g., for a graph, the units of the data being graphed)

Show Source Code

T3Annotation* T3DataViewMain::AnnoteRectangle ( bool data_units, float pos_x, float pos_y, float pos_z, float size_x = 0.5, float size_y = 0.5, float size_z = 0.0, float line_width = 1.0, taString& color = black, bool fill = false, taString& fill_color = white )

add a rectangle annotation -- coordinates are in the normalized coordinates of the view (typically 1x1x1) or if data_units = true, in natural data units of the view (e.g., for a graph, the units of the data being graphed)

Show Source Code

T3Annotation* T3DataViewMain::AnnoteStartArrow ( bool data_units, float pos_x, float pos_y, float pos_z, float size_x = 0.5, float size_y = 0.0, float size_z = 0.0, float line_width = 1.0, taString& color = black, float arrow_size = 0.02 )

add a line with a starting arrow annotation -- coordinates are in the normalized coordinates of the view (typically 1x1x1) or if data_units = true, in natural data units of the view (e.g., for a graph, the units of the data being graphed)

Show Source Code

T3Annotation* T3DataViewMain::AnnoteText ( bool data_units, taString& text, float pos_x, float pos_y, float pos_z, float font_size = 0.05, T3DataViewMain::TextJust just = LEFT, taString& color = black )

add a text annotation -- coordinates are in the normalized coordinates of the view (typically 1x1x1) or if data_units = true, in natural data units of the view (e.g., for a graph, the units of the data being graphed) for lower left start of text

Show Source Code

void NetView::BuildAll ( )

subclass-dependent operation -- reinvoked after major update -- builds any sub-dataview objects, but not the corresponding So guys (which is done in render) creates fully populated subviews (but not So -- that is done in Render)

Show Source Code

void T3DataViewMain::BuildAnnotations ( )

add a call in your BuildAll() function to this -- will add all the annotation objects to the display

Show Source Code

void T3DataView::ChildClearing ( taDataView* child )

override to implement par's portion of clear NOTE: child is always a T3DataView

Show Source Code

void T3DataView::ChildRendered ( taDataView* child )

override to implement par's portion of render NOTE: child is always a T3DataView

Show Source Code

void T3DataView::Clear ( taDataView* par = __null )

clears the view (but doesn't delete any components) (usually override _impl) -- for 3D views this removes the 3D objects from the view, but preserves the viewer-side of the hierarchy

Show Source Code

void NetView::ClearCaption ( )

Show Source Code

void T3DataViewMain::CloseChild ( taDataView* child )

Show Source Code

void NetView::CopyFromView ( NetView* cp )

special copy function that just copies user view options in a robust manner

Show Source Code

void T3DataViewMain::CopyFromViewFrame ( T3DataViewPar* cp )

copy key view frame parameters from other view object

Show Source Code

void NetView::DataUnitsXForm ( taVector3f& pos, taVector3f& size )

transform position and size values into native units of the display (e.g., for a graph, the units of what is being graphed) -- override in implementations

Show Source Code

void T3DataView::DoActions ( taDataView::DataViewAction acts )

do the indicated action(s) if safe in this context (ex loading, whether gui exists, etc.)

Show Source Code

bool T3DataViewMain::DoClearOnHide ( )

Show Source Code

bool T3DataViewMain::DoRender_pre ( )

decide if we should do render pre

Show Source Code

int T3DataView::EditAction_ ( ISelectable_PtrList& sel_items, int ea, ISelectable::GuiContext sh_typ = GC_DEFAULT )

do the indicated edit action (called from browser or list view); normally implement the _impl

Show Source Code

UnitView* NetView::FindUnitView ( UnitState_cpp* unit )

find the uv for the unit

Show Source Code

MemberDef* T3DataView::GetDataMemberDef ( )

returns md if known and/or knowable (ex. NULL for list members)

Show Source Code

TypeDef* T3DataView::GetDataTypeDef ( )

convenience function, default gets data type from link TypeDef of the data

Show Source Code

TypeDef* T3DataView::GetEffDataTypeDef ( ISelectable::GuiContext sh_typ = GC_DEFAULT )

gets it from effLink

Show Source Code

T3Panel* T3DataView::GetFrame ( )

get the T3Panel that owns us

Show Source Code

taString T3DataView::GetLabel ( )

returns a label suitable for tabview tabs, etc.

Show Source Code

int NetView::GetLayDispMode ( taString& lay_nm )

get the layer display mode value for given layer name (called by LayerView BuildAll)

Show Source Code

void NetView::GetMaxSize ( )

get max size from network

Show Source Code

void NetView::GetMembs ( )

Show Source Code

taBase* T3DataView::GetOwner ( )

Show Source Code

taBase* T3DataView::GetOwnerOfType ( TypeDef* td )

Show Source Code

TypeDef* NetView::GetTypeDef ( )

Show Source Code

void NetView::GetUnitDisplayVals ( UnitGroupView* ugrv, taVector2i& co, float& val, iColor& col, float& sc_val )

Show Source Code

bool NetView::HistBack1 ( )

move through history of saved values -- back 1

Show Source Code

bool NetView::HistBackAll ( )

move through history of saved values -- back all the way

Show Source Code

bool NetView::HistBackF ( )

move through history of saved values -- back fast

Show Source Code

bool NetView::HistFwd1 ( )

move through history of saved values -- forward 1

Show Source Code

bool NetView::HistFwdAll ( )

move through history of saved values -- forward all the way

Show Source Code

bool NetView::HistFwdF ( )

move through history of saved values -- forward fast

Show Source Code

taString NetView::HistMemUsed ( )

returns amount of memory used to store history in user-readable format

Show Source Code

void NetView::HistMovie ( int x_size = 720, int y_size = 720, taString& fname_stub = movie_img_ )

record individual frames of the netview display from current position through to the end of the history buffer, as movie frames -- use ffmpeg http://ffmpeg.org to compile the individual PNG frames into an mp4 movie -- e.g., ffmpeg -framerate 10 -i movie_img_%05d.png -vcodec libx264 -pix_fmt yuv420p -crf 25 movie.mp4

Show Source Code

void T3DataView::IgnoredSigEmit ( taSigLink* dl, int sls, void* op1, void* op2 )

called instead if ignoreSigEmit was true

Show Source Code

void NetView::InitCtrHist ( bool force = false )

initialize counter history based on current settings -- this also serves as master for all history -- if force, then always reset history index positions too

Show Source Code

void NetView::InitDisplay ( bool init_panel = true )

hard reset of display, esp. Unit values -- also calls BuildAll. Note this does not call Render -- that is done by UpdateDisplay, so a full reset is InitDisplay followed by UpdateDisplay

Show Source Code

bool NetView::InitHotVars ( )

init default 'hot' vars from directives

Show Source Code

void NetView::InitPanel ( )

hard reset of panel, esp. membr vars

Show Source Code

void NetView::InitScaleRange ( ScaleRange& sr )

initialize sr to its defaults; used when creating, and if user clicks 'default' button for the scale

Show Source Code

void T3DataView::ItemRemoving ( taDataView* item )

items call this on the root item -- usually used by a viewer to insure item removed from things like sel lists

Show Source Code

void NetView::Layer_DataUAE ( LayerView* lv )

send a DataUAE for all prjns for this layer

Show Source Code

void NetView::NewLayer ( int x = 3, int y = 3 )

Show Source Code

int T3DataView::QueryEditActions_ ( ISelectable_PtrList& sel_items, ISelectable::GuiContext sh_typ = GC_DEFAULT )

called to get edit items available on clipboard for the sel_items

Show Source Code

void T3DataViewMain::ReBuildAll ( )

calls Reset, BuildAll, Render -- a full rebuild -- when something structural has changed (outside of normal signal mechanism, which does this automatically on SigRecvStructUpdateEnd_impl

Show Source Code

void T3DataView::ReInit ( )

perform a reinitialization, particularly of visual state -- overload _impl

Show Source Code

int T3DataView::RefUnref ( bool ref )

ref'ed/unrefed in select lists etc.; optional, and can be used for lifetime mgt; returns count after operation

Show Source Code

void T3DataView::Refresh ( )

for manual refreshes -- just the impl stuff, not structural stuff

Show Source Code

void T3DataView::Render ( )

renders the visible contents (usually override the _impls) -- MUST BE DEFINED IN SUB

Show Source Code

void T3DataViewMain::Render_impl ( )

Show Source Code

void T3DataViewMain::Render_pre ( )

Show Source Code

void T3DataView::Reset ( )

clears, and deletes any components (usually override _impls)

Show Source Code

void NetView::SaveCtrHist ( )

save counter history -- called in UpdateUnitValues()

Show Source Code

void NetView::SaveImageSVG ( taString& svg_fname )

render an svg version of this item to given file name

Show Source Code

void NetView::SelectVar ( char* var_name, bool add = false, bool update = true )

select given variable for viewing on units (add to currently disp vars if add)

Show Source Code

void NetView::SetColorSpec ( ColorScaleSpec* color_spec )

set the color scale spec to determine the palette of colors representing values

Show Source Code

void T3DataView::SetData ( taBase* ta )

set the data to which this points -- must be subclass of data_base

Show Source Code

void NetView::SetHighlightSpec ( BaseSpec* spec )

Show Source Code

void NetView::SetLayDispMode ( taString& lay_nm, int disp_md )

set the layer display mode value for given layer name (called by LayerView UAE)

Show Source Code

void NetView::SetScaleData ( bool auto_scale, float scale_min, float scale_max, bool update_panel = true )

updates the values in us and the stored ones in the colorscale list

Show Source Code

void NetView::SetScaleDefault ( )

revert scale to its default

Show Source Code

void T3DataView::SetVisible ( bool showing )

called recursively when a view ctrl shows or hides

Show Source Code

bool NetView::ShowDraggers ( )

instructions from the parent about whether sub-guys should show draggers

Show Source Code

void T3DataView::SigDestroying ( )

called when data is destroying (m_data will already be NULL) called by data when it is destroying -- usual action is to destroy ourself

Show Source Code

void T3DataView::SigLinkDestroying ( taSigLink* dl )

called by SigLink when destroying; it will remove siglink ref in dlc upon return called by SigLink when destroying; it will remove

Show Source Code

void T3DataView::SigLinkRecv ( taSigLink* dl, int sls, void* op1, void* op2 )

this is how we receive a signal from the siglink

Show Source Code

void T3DataView::SigRecvUpdateAfterEdit ( )

note: normally overrride the _impl

Show Source Code

void T3DataView::SigRecvUpdateAfterEdit_Child ( taDataView* chld )

optionally called by child in its DUAE routine; must be added manually

Show Source Code

void* T3DataView::This ( )

reference to the 'this' pointer of the client object

Show Source Code

void T3DataView::Unbind ( )

clears, and deletes any components (usually override _impls)

Show Source Code

void NetView::UpdateDisplay ( bool update_panel = true )

re-renders entire display (calls Render_impl) -- assumes structure is still same but various display elements may have changed. if structure is different, then an InitDisplay is required first

Show Source Code

void NetView::UpdateName ( )

update name from network

Show Source Code

void NetView::UpdatePanel ( )

updates nvp, esp. after UAE etc.

Show Source Code

void T3DataView::UpdatePointersAfterCopy_ ( taBase& cp )

Show Source Code

void T3DataView::UpdatePointersAfterCopy_impl ( taBase& cp )

Show Source Code

void NetView::UpdateUnitValues ( )

*only* updates unit values -- display and structure must be the same as last time

Show Source Code

void NetView::UpdateViewerModeForMd ( MemberDef* md )

update viewer interaction/viewer mode based on type of member def to view -- only call for interactive view changes

Show Source Code

void T3DataView::ViewProperties ( )

show the view properties for this object

Show Source Code

taSigLink** T3DataView::addr_sig_link ( )

Show Source Code

taiSigLink* T3DataView::clipParLink ( ISelectable::GuiContext sh_typ = GC_DEFAULT )

for tree stuff, we use the gui parent for clip ops; for t3 we use the eff_data owner not par_link

Show Source Code

taBase* T3DataView::data ( )

subclasses usually redefine a strongly typed version

Show Source Code

int T3DataView::dbuCnt ( )

batch update: -ve:data, 0:none, +ve:struct

Show Source Code

taiSigLink* T3DataView::effLink ( ISelectable::GuiContext sh_typ = GC_DEFAULT )

for trees and things like layers, we just just use the data, for things like graphs (where view==data) we use the view itself (override shType)

Show Source Code

bool T3DataView::expandable ( )

Show Source Code

bool T3DataView::fixTransformAxis ( )

make sure transform doesn't have a zero axis

Show Source Code

bool T3DataViewMain::hasChildren ( )

Show Source Code

bool T3DataView::hasParent ( )

encapsulated way to check for a par

Show Source Code

bool NetView::hasViewProperties ( )

true if this item has editable view properties, and should be shown TODO: NUKE, OBS

Show Source Code

bool T3DataView::ignoreSigEmit ( )

hidden guys can ignore changes (but they always get Destroyed)

Show Source Code

int T3DataView::index ( )

convenience accessor

Show Source Code

bool T3DataView::isDataView ( )

true for dataviews

Show Source Code

bool T3DataView::isMapped ( )

is the window mapped and ready for drawing -- mostly relevant for 3d classes that have a parallel 3D object hierarchy, where it indicates if the 3d classes have been created, which should only occur when the window is visible only true if in gui mode and gui stuff exists

Show Source Code

taiSigLink* T3DataView::link ( )

Show Source Code

taSigLink* T3DataView::link_ ( )

Show Source Code

MemberDef* T3DataView::md ( )

ISelectable property member stub

Show Source Code

Network* NetView::net ( )

Show Source Code

taiSigLink* T3DataView::own_link ( ISelectable::GuiContext sh_typ = GC_DEFAULT )

owner item's link -- this is the *eff_data* parent (not the gui parent)

Show Source Code

ISelectable* T3DataView::par ( )

gui parent, if any

Show Source Code

int T3DataView::parDbuCnt ( )

dbu of parent(s); note: only sign is accurate, not necessarily value (optimized)

Show Source Code

taiSigLink* T3DataView::par_link ( )

parent item's link -- this is the *gui* parent (not the data parent/owner)

Show Source Code

MemberDef* T3DataView::par_md ( )

eff_data parent item's (if any) md

Show Source Code

T3DataView* T3DataView::parent ( )

Show Source Code

TypeDef* T3DataView::parentType ( )

the controlling parent -- note that when in a list, this is the list owner, not the list; overrride for strong check in SetOwner always a T3DataView (except root guy)

Show Source Code

T3DataViewRoot* T3DataView::root ( )

Show Source Code

void T3DataView::setExpandable ( bool na )

Show Source Code

void T3DataViewMain::setInteractionModeOn ( bool on_off, bool re_render = true )

set the interaction mode for the underlying examiner viewer -- does update and re-render unless specified as false

Show Source Code

void NetView::setUnitDisp ( int value )

sets a new md to display, index in membs

Show Source Code

void NetView::setUnitDispMd ( MemberDef* md )

sets a new md to display, lookup/set scale values

Show Source Code

void NetView::setUnitSrc ( UnitView* uv, UnitState_cpp* unit )

updates picked unit

Show Source Code

ISelectable::GuiContext T3DataView::shType ( )

mediates menu handling, and default source for clip ops

Show Source Code

taBase* T3DataView::taData ( ISelectable::GuiContext sh_typ = GC_DEFAULT )

if the eff_data is taBase, this returns it

Show Source Code

taTransform* T3DataView::transform ( bool auto_create = false )

transform, in Inventor coords

Show Source Code

taiSigLink* T3DataView::viewLink ( )

only defined for T3 guys data of the link

Show Source Code

int T3DataView::visCount ( )

what is the visibility count for this window -- 1 or more should be visible, 0 should be not visible

Show Source Code

Static Member and Method Documentation

Static Members

Static Methods

Static Method Category: ObjectMgmt

Static Method Category: _NoCategory


Static Method Documentation

Static Method Category: ObjectMgmt

void T3DataView::CallObjFun ( taBase* obj, taString& fun_name )   [static]

call function (method) of given name on given object, prompting for args using gui interface

Show Source Code

void T3DataView::SetMemberStr ( taBase* obj, taString& memb_name, taString& str )   [static]

set member value based on string value -- memb_name can be an arbitrary full path below the obj

Show Source Code

void T3DataView::SetMemberVar ( taBase* obj, taString& memb_name, Variant& val )   [static]

set member value based on variant -- memb_name can be an arbitrary full path below the obj

Show Source Code

Static Method Category: _NoCategory

NetView* NetView::New ( Network* net, T3Panel*& fr )   [static]

create a new instance and add to viewer

Show Source Code

bool NetView::UsesSpec ( taBase* obj, BaseSpec* spec )   [static]

Show Source Code

Expert Member and Method Documentation

Expert Members

Expert Member Category: _NoCategory

Expert Member Category: taBase

Expert Methods

Expert Method Category: Access

Expert Method Category: Display

Expert Method Category: File

Expert Method Category: UserData


Expert Member Documentation

Expert Member Category: _NoCategory

T3DataViewMain::annotations : T3Annotation_List

extra annotations (lines, arrows, text, etc) to add to the 3d view

NetView::ctr_hist : String_Matrix

[n_counters][hist_max] buffer of history of previous counter data -- saved as text -- used in net_text display

NetView::ctr_hist_idx : CircMatrix

circular buffer indexing for ctr_hist

NetView::cur_unit_vals : String_Array

currently selected unit values to display -- theoretically can display multiple values, but this is not currently supported, so it always just has one entry at most

taDataView::data_base : TypeDef*

Minimum type for data object

NetView::eff_max_size : taVector3f

effective maximum size in each dimension of the net for current view

T3DataView::flags : int

any of T3DataViewFlags TODO: tbd

NetView::hist_idx : int

history index -- when rewinding backwards, how many steps back from current time to view -- -1 = present

NetView::hist_reset_req : bool

reset of history index position requested because of data reset in one or more of the unit groups

NetView::lay_disp_modes : NameVar_Array

layer display modes (not properly saved otherwise, due to reset construction of LayerViews)

taDataView::m_data : taBase*

data -- referent of the item (not ref'ed)

T3DataView::m_transform : taTransform*

transform, created only if not unity

NetView::max_size : taVector3f

maximum size in each dimension of the net

NetView::max_size2d : taVector3f

maximum size in each dimension of the net for 2D display purposes (using pos2d)

NetView::membs : MemberSpace

list of all the members possible in units; note: all items are new clones

NetView::n_counters : int

number of counter variables on the network object

NetView::prjn_starts_with : taString

based on the con_type setting, what the projection name should start with

NetView::scale_ranges : ScaleRange_List

Auto ranges for member buttons

NetView::unit_con_md : bool

true if memberdef is from a connection as opposed to a direct unit var

NetView::unit_disp_idx : int

index of memberdef (if any) of Unit (or Connection) to display

NetView::unit_disp_md : MemberDef*

memberdef (if any) of Unit (or Connection) to display

NetView::unit_md_flags : NetView::MDFlags

type to display in units

NetView::unit_scrng : ScaleRange*

scalerange of disp_md

NetView::unit_src : UnitState_cpp*

unit last picked (if any) for display

NetView::unit_src_path : taString

path of unit_src unit relative to the network -- used for saving and reloading

NetView::unit_wt_act : bool

true if memberdef is r.wt*act

Expert Member Category: taBase

taOBase::owner : taBase*

pointer to owner

taOBase::user_data_ : UserDataItem_List*

storage for user data (created if needed) DO NOT ACCESS this list directly -- use the GetUserData / SetUserData etc interface!


Expert Method Documentation

Expert Method Category: Access

taMatrix* T3DataView::ElView ( )

View of list -- matrix that specifies a subset of items to view, for display and other kinds of functions

Show Source Code

taBase::IndexMode T3DataView::ElViewMode ( )

View mode for view of list -- specifies what kind of view data there is, for display and other kinds of functions -- only valid cases are IDX_COORDS or IDX_MASK, or IDX_UNK if no view specified

Show Source Code

int T3DataView::ElemCount ( )

number of elements in the container -- used for iteration control

Show Source Code

taBase::IndexMode T3DataView::IndexModeDecode ( Variant& idx, int cont_dims )

decode index mode from variant index, and number of dimensions in the container object

Show Source Code

bool T3DataView::IndexModeValidate ( Variant& idx, taBase::IndexMode md, int cont_dims )

validate that the index is of an appopriate configuration for given index mode -- issues appropriate error messages if not good

Show Source Code

Expert Method Category: Display

void T3DataView::WindowHideHook ( )

this is called when a top-level window that represents this object becomes invisible

Show Source Code

void T3DataView::WindowShowHook ( )

this is called when a top-level window that represents this object becomes visible

Show Source Code

Expert Method Category: File

int T3DataView::Load_String ( taString& load_str, taBase* par = __null, taBase** loaded_obj_ptr = __null )

load full object information from a string, which should have been generated through a corresponding Save_String call -- must contain the exact information that would be saved to a file for Save_strm -- just a string-stream (sstream) wrapper around Load_strm

Show Source Code

int T3DataView::Load_strm ( istream& strm, taBase* par = __null, taBase** loaded_obj_ptr = __null )

Load object data from a file -- sets pointer to loaded obj if non-null: could actually load a different object than this (e.g. if this is a list or group)

Show Source Code

int T3DataView::Save_String ( taString& save_str, taBase* par = __null, int indent = 0 )

dump full object save information to a string, which contains the exact information that would be saved to a file for Save_strm -- just a string-stream (sstream) wrapper around Save_strm

Show Source Code

int T3DataView::Save_strm ( ostream& strm, taBase* par = __null, int indent = 0 )

Save object data to a file stream

Show Source Code

Expert Method Category: UserData

taDoc* T3DataView::GetDocLink ( )

gets a linked Doc, if any; you can use this to test for existence

Show Source Code

bool T3DataView::GetUserDataAsBool ( taString& key )

get specified user data as bool (see GetUserData)

Show Source Code

double T3DataView::GetUserDataAsDouble ( taString& key )

get specified user data as double (see GetUserData)

Show Source Code

float T3DataView::GetUserDataAsFloat ( taString& key )

get specified user data as float (see GetUserData)

Show Source Code

int T3DataView::GetUserDataAsInt ( taString& key )

get specified user data as int (see GetUserData)

Show Source Code

const taString T3DataView::GetUserDataAsString ( taString& key )

get specified user data as String (see GetUserData)

Show Source Code

const Variant T3DataView::GetUserDataDef ( taString& key, Variant& def )

return value if exists, or default if doesn't

Show Source Code

UserDataItem_List* T3DataView::GetUserDataList ( bool force = false )

gets the userdatalist for this class

Show Source Code

UserDataItemBase* T3DataView::GetUserDataOfType ( TypeDef* typ, taString& key, bool force_create )

gets specified user data of given type, making one if doesn't exist and fc=true

Show Source Code

bool T3DataView::HasUserDataList ( )

returns true if UserData exists at al

Show Source Code


Copyright © 2017Regents of the University of Colorado, Carnegie Mellon University, Princeton University.
emergent 8.2.2