Document¶

class Document

The guerilla document singleton

The guerilla document is a singleton named 'Document'. You can use it like this :

local currentFrame = Document.Time:Get ()

Hierarchy

class Document < class Node

Members

Plugs:

float	FirstFrame	RW	The first frame of the project
float	LastFrame	RW	The last frame of the project
float	Time	RW	The current frame number

Methods:

string filename	getfilename	( )	Get the Document file name
table modifier	getmodifier	( )	Get a document modifier.
Node preferences	getpreferences	( )	Get the Document preferences node
table selection	getselection	( )	Get the current selection as a table
nil	haschanged	( )	Return true if the document has been modified since the last save.
transform\|geometry\|float data	loadBakedData	( SceneGraphNode node , string name )	Load the data from the baked file of the SceneGraphNode (.ghostdata).
table modifier	modify	( )	Start a document modification context.

Inherited from class Node

Plugs:

string

Name

RW

The node name

Methods:

nil	onpathchanged	( )	Called by the framework when the name of this node or of one of its parent is modified
any value	eval	( Plug plug )	Called by the framework when plug (a node's plug) must be evaluated
boolean state	isselected	( )	Tell if the node is selected
Node parent	getparent	( )	Get the parent Node of this Node
boolean result	isparent	( Node child )	Tells if this node is parent of the potential child
Node parent	findparent	( string name )	Find the first parent Node of this Node of a specific class
string path	getpath	( )	Returns the node path as a string that can be reused with findchild
Node\|Plug child	findchild	( string path )	Find a child node or plug using a path
nil	move	( Node parent )	Move a node to a new parent
nil	delete	( )	Delete a node
nil	rename	( string name )	Rename a node
[string\|number] name	getname	( )	Get the Node name in its parent
Node result	getchild	( string name )	Get a child node by its name
boolean result	isreference	( )	Tells if a node comes from a reference project
Reference reference	getreference	( )	Returns the reference node it is connected to
Reference reference	gettopreference	( )	Returns the top reference node it is connected to
bool result	belongstoreference	( Reference ref )	Tells if the node belongs to the reference, or a sub reference
{Node} result	loadfile	( string filename )	load a file content in this node.
Node result	loadtemplate	( string template , string name )	load a template file
bool,string success,error	savefile	( string filename )	load a node to a file
string result	getstringcopy	( )	Return a copy of the node and its content as a string to be pasted
nil	setflags	( )	Set the node flags
bool result	ismoveable	( )	Tells if the node can be moved
{Node},string result,error	pastestringcopy	( string copy )	Paste a string copy into this node
of table	getreferences	( [ topref Reference ] )	Returns the references in the document sorted depth first.
boolean editable	iseditable	( )	Indicates if the node can be edited by the user in the UI
nil	seteditable	( boolean editable )	Change the editable state of the node

Documentation

float FirstFrame RW

The first frame of the project

float LastFrame RW

The last frame of the project

float Time RW

The current frame number

string filename getfilename ( )

Get the Document file name

Return:

filename The document filename

table modifier getmodifier ( )

Get a document modifier.

Get a document modifier which is compatible with the current document modification state. It is then always safe to perform document modification, even when not in a undoable modification context. However, selection cannot be modified in a non undoable context.

Return:

modifier

Node preferences getpreferences ( )

Get the Document preferences node

Return:

preferences The preferences of the document

table selection getselection ( )

Get the current selection as a table

Return:

selection the current selection or nil if no selection

nil haschanged ( )

Return true if the document has been modified since the last save.

transform|geometry|float data loadBakedData ( SceneGraphNode node , string name )

Load the data from the baked file of the SceneGraphNode (.ghostdata).

Arguments:

node The node to use to load the data
name The attribute name to load

Return:

data The data

table modifier modify ( )

Start a document modification context.

When operating in a command or whatever context that might require undo stacking, it is needed to create a modification context in which all actions are stacked. Note that not all actions require stacking, such as UI handling, object or plug creation or connection inside a constructor. Document undoable modifications are strictly reserved for UI interaction with the document, such as commands, controls, gizmos.
This method opens a new modification context, in which actions are stacked. This method returns a modifier table that contains all actions that can be performed on the document.

See also Modifier for more documentation.

Return:

modifier