vrdReferenceNode¶
-
class
vrdReferenceNode¶
(Inherits vrdTransformNode)
Reference node.
Summary¶
- Functions:
- createSmartPath(location, customPath) → string
- createSmartReference(useSourcePath)
- createSourceReference()
- getSmartCreationDate() → QDateTime
- getSmartFileState() → vrReferenceTypes.FileState
- getSmartLastModified() → QDateTime
- getSmartOwner() → string
- getSmartPath() → string
- getSmartRevision() → string
- getSmartRevisionPath(revision) → string
- getSmartRevisions() → List[string]
- getSourceFileState() → vrReferenceTypes.FileState
- getSourceImportDate() → QDateTime
- getSourceLastModified() → QDateTime
- getSourceOwner() → string
- getSourcePath() → string
- getSourceRevision() → string
- getSourceRevisionPath(revision) → string
- getSourceRevisions() → List[string]
- getState() → vrReferenceTypes.State
- hasSmartReference() → bool
- hasSourceReference() → bool
- isChanged() → bool
- isLoaded() → bool
- isRootNode() → bool
- isSelfOrSubReferenceChanged() → bool
- isSubReferenceChanged() → bool
- load()
- loadSmartReference()
- loadSourceReference()
- removeSmartReference()
- removeSourceReference()
- saveSmartReference()
- saveSmartReferenceAs(path, unshare)
- setSmartPath(path)
- setSourcePath(path)
- unload()
Functions¶
-
vrdReferenceNode.createSmartPath(location, customPath='')¶ Constructs the path to the smart file.
Parameters: - location (vrReferenceTypes.ExportLocation) – The type of locaton
- customPath (string) – If the type is custom, this parameter conteins the custom path
Returns: Path to the smart file
Return type: string
-
vrdReferenceNode.createSmartReference(useSourcePath=False)¶ Creates a smart file reference for this reference.
Parameters: useSourcePath (bool) –
-
vrdReferenceNode.createSourceReference()¶ Creates a source file reference for this reference.
-
vrdReferenceNode.getSmartCreationDate()¶ Returns: The creation date of the smart file on disk Return type: QDateTime
-
vrdReferenceNode.getSmartFileState()¶ Returns: The status of the smart file Return type: vrReferenceTypes.FileState
-
vrdReferenceNode.getSmartLastModified()¶ Returns: The modification time of the smart file Return type: QDateTime
-
vrdReferenceNode.getSmartOwner()¶ Returns: The file owner of the smart file Return type: string
-
vrdReferenceNode.getSmartPath()¶ Returns: Path to the smart file Return type: string
-
vrdReferenceNode.getSmartRevision()¶ Returns: The current smart revision. Return type: string
-
vrdReferenceNode.getSmartRevisionPath(revision)¶ Parameters: revision (string) – Returns: The path to the smart file with the given revision Return type: string
-
vrdReferenceNode.getSmartRevisions()¶ Returns: A list of available smart revisions Return type: List[string]
-
vrdReferenceNode.getSourceFileState()¶ Returns: The status of the sources file Return type: vrReferenceTypes.FileState
-
vrdReferenceNode.getSourceImportDate()¶ Returns: The time at which the file was imported Return type: QDateTime
-
vrdReferenceNode.getSourceLastModified()¶ Returns: The modification date of the sources file Return type: QDateTime
-
vrdReferenceNode.getSourceOwner()¶ Returns: The file owner of the sources file Return type: string
-
vrdReferenceNode.getSourcePath()¶ Returns: Path to the source file Return type: string
-
vrdReferenceNode.getSourceRevision()¶ Returns: The current source revision. Return type: string
-
vrdReferenceNode.getSourceRevisionPath(revision)¶ Parameters: revision (string) – Returns: The path to the source file with the given revision Return type: string
-
vrdReferenceNode.getSourceRevisions()¶ Returns: A list of available source revisions Return type: List[string]
-
vrdReferenceNode.getState()¶ Get the current status of the reference node.
Returns: Loaded, Unloaded or New Return type: vrReferenceTypes.State
-
vrdReferenceNode.hasSmartReference()¶ Returns: True if this reference is dynamically loaded from a project file Return type: bool
-
vrdReferenceNode.hasSourceReference()¶ Returns: True if this reference points to a source file. Return type: bool
-
vrdReferenceNode.isChanged()¶ Returns: True if the content of the reference has been modified without saving Return type: bool
-
vrdReferenceNode.isLoaded()¶ Returns: True if this reference is loaded Return type: bool
-
vrdReferenceNode.isRootNode()¶ Returns: True if this reference is the scene root node Return type: bool
-
vrdReferenceNode.isSelfOrSubReferenceChanged()¶ Returns: True if vrdReferenceNode.isChanged() is true and vrdReferenceNode.isSubReferenceChanged() is true Return type: bool
-
vrdReferenceNode.isSubReferenceChanged()¶ Returns: True if one of the sub references has unsaved changes Return type: bool
-
vrdReferenceNode.load()¶ Loads the reference content.
-
vrdReferenceNode.loadSmartReference()¶ Loads the reference content, if this reference contains a source reference.
-
vrdReferenceNode.loadSourceReference()¶ Loads the reference content, if this reference contains a smart reference.
-
vrdReferenceNode.removeSmartReference()¶ Removes the smart reference information from this reference.
-
vrdReferenceNode.removeSourceReference()¶ Removes the source reference information from this reference.
-
vrdReferenceNode.saveSmartReference()¶ Save changes to the referenced project file.
-
vrdReferenceNode.saveSmartReferenceAs(path, unshare)¶ Save content of the reference to a new project file.
Parameters: - path (string) – The project file name
- unshare (bool) – If true, unshare and only linke this instance to the new project
-
vrdReferenceNode.setSmartPath(path)¶ Change the path to the smart reference file.
Parameters: path (string) – The new path to the file
-
vrdReferenceNode.setSourcePath(path)¶ Change the path to the source file.
Parameters: path (string) – The new path of the source file
-
vrdReferenceNode.unload()¶ Remove all children of this node and mark as not loaded.