HostReferenceΒΆ
class HostReference
A HostReference is a Reference on an exported scene graph.
The principle of the HostReference is to hold the straight export of a 'Host' (e.g. Maya, 3dsMax, ...)
scene graph, which is then referenced into a main Guerilla project, so every time one need to re-export data from the
Host to Guerilla, only the HostReference is overwritten, and its content is then merged into the main project as a reference.
The only difference between a Reference and a HostReference is that the HostReference won't prefix the referenced objects
names.
Hierarchy
class HostReference < class Reference < class ReferenceBase < class HostNode < class SelectableNode < class Node
Members
Inherited from class ReferenceBase
Plugs:
string | ReferenceFileName | R | The path of the referenced file |
string | ReferenceActualFileName | R | The actual path of the referenced file, in case the reference path had to be resolved |
string | ReferencePathOverride | R | The path override, so it possible to load another file instead of the original file |
boolean | LoadHostReferences | WR | If true, load the sub host references (references with no prefixes). |
boolean | Loaded | R | Tells if the reference is loaded or not. Must not be modified direclty. |
Methods:
| unload | ( ) | For internal use only. |
| reload | (
|
Reload the reference from disk. Using the filename argument, the method will switch the reference for another one. The edits (modifications done on the reference) are re-applied after the reload. |
Inherited from class HostNode
Plugs:
types.string | HostPath | RW | The data archive to read HostPlugs value when baked |
Methods:
| deleteinheritedattr | (
|
Delete an inherited attribute plug from the node |
| overrideinheritedattr | (
|
Override the attribute |
| setinheritedattr | (
|
Set the inheritance status of the attribute |
Inherited from class SelectableNode
Plugs:
boolean | Selected | R | True if the node is selected. Don't use this plug directly to select a node, use the Document's modifier select method. |
Inherited from class Node
Plugs:
string | Name | RW | The node name |
Methods:
| onpathchanged | ( ) | Called by the framework when the name of this node or of one of its parent is modified |
| eval | (
|
Called by the framework when plug (a node's plug) must be evaluated |
| isselected | ( ) | Tell if the node is selected |
| getparent | ( ) | Get the parent Node of this Node |
| isparent | (
|
Tells if this node is parent of the potential child |
| findparent | (
|
Find the first parent Node of this Node of a specific class |
| getpath | ( ) | Returns the node path as a string that can be reused with findchild |
| findchild | (
|
Find a child node or plug using a path |
| move | (
|
Move a node to a new parent |
| delete | ( ) | Delete a node |
| rename | (
|
Rename a node |
| getname | ( ) | Get the Node name in its parent |
| getchild | (
|
Get a child node by its name |
| isreference | ( ) | Tells if a node comes from a reference project |
| getreference | ( ) | Returns the reference node it is connected to |
| gettopreference | ( ) | Returns the top reference node it is connected to |
| belongstoreference | (
|
Tells if the node belongs to the reference, or a sub reference |
| loadfile | (
|
load a file content in this node. Possible options are: overrideclass to enforce a specific class for the root node. |
| referencefile | (
|
reference a file content in this node. |
| loadtemplate | (
|
load a template file |
| savefile | (
|
load a node to a file |
| getstringcopy | ( ) | Return a copy of the node and its content as a string to be pasted |
| setflags | ( ) | Set the node flags |
| ismoveable | ( ) | Tells if the node can be moved |
| pastestringcopy | (
|
Paste a string copy into this node |
| getreferences | (
[
|
Returns the references in the document sorted depth first. |
| iseditable | ( ) | Indicates if the node can be edited by the user in the UI |
| seteditable | (
|
Change the editable state of the node |
| isindocument | ( ) | Tells if the node is inside a document, or is pending in the void |