UserData Utility

Functions
function	__ug__CheckUserDataArgType (r, l)
function	__ug__UserNumber_add (l, r)
function	__ug__UserNumber_div (l, r)
function	__ug__UserNumber_mul (l, r)
function	__ug__UserNumber_pow (l, r)
function	__ug__UserNumber_sub (l, r)
function	__ug__UserNumber_sum (lScale, l, rScale, r)
function	FreeUserData ()
function	FreeUserDataInTable (t)
function	ListUserData ()
function	ListUserDataInTable (t, name)
function	set_user_data_overloads (name)

Detailed Description

Some usage info: FreeUserDataInTable, FreeUserData.

Name of instance of ug4-object: ug_class_name(obj) (returns "" if not a ug4 class) Check if class is base class: ug_is_base_class("BaseClass", "DerivClass") Check if dimension compiled in: ug_dim_compiled(dim) Returning metatable for a ug4-class: ug_get_metatable("ClassName")

Function Documentation

__ug__CheckUserDataArgType()

function __ug__CheckUserDataArgType	(	r	,
		l
	)

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / user_data_util.lua :115-174

__ug__UserNumber_add()

function __ug__UserNumber_add	(	l	,
		r
	)

functions used when '+' is called on an UserData (or a derived implementation)

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / user_data_util.lua :255-257

function __ug__UserNumber_add(l,r)
  return __ug__UserNumber_sum(1.0, l, 1.0, r)
end

__ug__UserNumber_div()

function __ug__UserNumber_div	(	l	,
		r
	)

functions user when '/' is called on an UserData (or a derived implementation)

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / user_data_util.lua :323-381

__ug__UserNumber_mul()

function __ug__UserNumber_mul	(	l	,
		r
	)

functions user when '*' is called on an UserData (or a derived implementation)

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / user_data_util.lua :269-320

__ug__UserNumber_pow()

function __ug__UserNumber_pow	(	l	,
		r
	)

functions user when '^' is called on an UserData (or a derived implementation)

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / user_data_util.lua :388-429

__ug__UserNumber_sub()

function __ug__UserNumber_sub	(	l	,
		r
	)

functions used when '-' is called on an UserData (or a derived implementation)

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / user_data_util.lua :260-262

function __ug__UserNumber_sub(l,r)
  return __ug__UserNumber_sum(1.0, l, -1.0, r)
end

__ug__UserNumber_sum()

function __ug__UserNumber_sum	(	lScale	,
		l	,
		rScale	,
		r
	)

functions user when '+/-' is called on an UserData (or a derived implementation)

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / user_data_util.lua :181-252

FreeUserData()

function FreeUserData

(

)

sets all userdata to nil (even in tables) and calls garbage collector

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / user_data_util.lua :95-111

function FreeUserData()
   for n,v in pairs(_G) do
      if type(v) == "userdata" then
     _G[n] = nil
      end
 
      if type(v) == "table" then
    if(n ~= "_G" and n ~= "io" and n ~= "package" and n ~= "gnuplot") then
        FreeUserDataInTable(_G[n])
       end
      end
   end
 
   collectgarbage("collect")
end

FreeUserDataInTable()

function FreeUserDataInTable

(

t

)

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / user_data_util.lua :79-92

function FreeUserDataInTable(t)
    for n,v in pairs(t) do
      if type(v) == "userdata" then
         t[n] = nil
      end
 
      if type(v) == "table" then
    if(n ~= "_G" and n ~= "io" and n ~= "package" and n ~= "gnuplot") then
      FreeUserDataInTable(v)
    end
      end
 
    end
end

ListUserData()

function ListUserData

(

)

Lists all user data (even in tables)

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / user_data_util.lua :63-77

function ListUserData()
    for n,v in pairs(_G) do
     if type(v) == "userdata" then
     print(n)
     end
 
    if type(v) == "table" then
      if(n ~= "_G" and n ~= "io" and n ~= "package" and n ~= "gnuplot") then
        ListUserDataInTable(_G[n], n)
      end
    end
    end
end

ListUserDataInTable()

function ListUserDataInTable	(	t	,
		name
	)

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / user_data_util.lua :48-60

function ListUserDataInTable(t, name)
    for n,v in pairs(t) do
      if type(v) == "userdata" then
     print(name.."["..n.."]")
      end
 
    if type(v) == "table" then
    if(n ~= "_G" and n ~= "io" and n ~= "package" and n ~= "gnuplot") then
      ListUserDataInTable(v, name.."["..n.."]")
    end
      end
    end
end

References name, and print().

set_user_data_overloads()

function set_user_data_overloads

(

name

)

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / user_data_util.lua :435-454

function set_user_data_overloads(name)
  mt = ug_get_metatable(name)
  if mt == nil then return end
 
  mt.__add = _G["__ug__UserNumber_add"]
 
  mt.__sub = _G["__ug__UserNumber_sub"]
 
  mt.__mul = _G["__ug__UserNumber_mul"]
 
  mt.__div = _G["__ug__UserNumber_div"]
 
  mt.__pow = _G["__ug__UserNumber_pow"]
end