public class SoFile extends SoNode
SoFile
node is written out, just the field containing the name of the file is written; no children are written out. When an SoFile
is encountered during reading, reading continues from the named file, and all nodes read from the file are added as hidden children of the file node.
Whenever the name
field changes, any existing children are removed and the contents of the new file is read in. The file node remembers what directory the last file was read from and will read the new file from the same directory after checking the standard list of directories (see SoInput
), assuming the field isn't set to an absolute path name.
The children of an SoFile
node are hidden; there is no way of accessing or editing them. If you wish to edit the contents of an SoFile
node, you can modify the contents of the named file and then "touch" the name
field (see SoField
). Alternatively, you can use the copyChildren()
method to get an editable copy of the file node's children. Note that this does not affect the original file on disk, however.
File format/default:
File {
name | "<Undefined file>" |
Action behavior:
SoGLRenderAction
, SoCallbackAction
, SoGetBoundingBoxAction
, SoGetMatrixAction
, SoHandleEventAction
Traverses its children just as SoGroup
does.
SoRayPickAction
Traverses its hidden children, but, if intersections are found, generates paths that end at the SoFile
node.
SoWriteAction
Writes just the name
field and no children.
See also:
SoNode.RenderModes
Inventor.ConstructorCommand
Modifier and Type | Field and Description |
---|---|
SoSFFilePathString |
name
Name of file from which to read children.
|
VERBOSE_LEVEL, ZeroHandle
Constructor and Description |
---|
SoFile()
Creates a file node with default settings.
|
Modifier and Type | Method and Description |
---|---|
SoGroup |
copyChildren()
Returns a new
SoGroup containing copies of all of the file node's children. |
static boolean |
getSearchOK()
Queries whether the search action will traverse the hidden children.
|
static void |
setSearchOK(boolean flag)
If flag is true, the search action will traverse hidden children.
|
affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderEngineMode, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write
copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults
dispose, getName, isDisposable, isSynchronizable, setName, setSynchronizable
getNativeResourceHandle
public final SoSFFilePathString name
public SoGroup copyChildren()
SoGroup
containing copies of all of the file node's children.public static boolean getSearchOK()
public static void setSearchOK(boolean flag)
Generated on July 31, 2019, Copyright © Thermo Fisher Scientific. All rights reserved. http://www.openinventor.com