SoFile Class

SoFile Class

Node that reads children from a named file.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.NodesSoNode
            OIV.Inventor.NodesSoFile

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.2.0.0 (2024.2.0)

Syntax

C++

Copy

public class SoFile : SoNode

Public Class SoFile
	Inherits SoNode

public ref class SoFile : public SoNode

type SoFile =  
    class
        inherit SoNode
    end

The SoFile type exposes the following members.

Constructors

	Name	Description
	SoFile	Creates a file node with default settings.

Top

Methods

	Name	Description
	AffectsState	Returns true if a node has an effect on the state during traversal. (Inherited from SoNode.)
	Callback	(Overrides SoNodeCallback(SoCallbackAction).)
	Copy	Calls Copy(false). (Inherited from SoNode.)
	Copy(Boolean)	Creates and returns an exact copy of the node. (Inherited from SoNode.)
	CopyChildren	Returns a new OIV.Inventor.Nodes.SoGroup containing copies of all of the file node's children.
	CopyFieldValues(SoFieldContainer)	Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.)
	CopyFieldValues(SoFieldContainer, Boolean)	Copies the contents of fc's fields into this object's fields. (Inherited from SoFieldContainer.)
	Dispose	Releases all resources used by SoDisposable. (Inherited from SoDisposable.)
	Distribute	(Inherited from SoNode.)
	DoAction	(Overrides SoNodeDoAction(SoAction).)
	EnableNotify	Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). (Inherited from SoFieldContainer.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FieldsAreEqual	Returns true if this object's fields are exactly equal to fc's fields. (Inherited from SoFieldContainer.)
	Get	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. (Inherited from SoFieldContainer.)
	GetAllFields	Returns a list of fields, including the eventIn's and eventOut's. (Inherited from SoFieldContainer.)
	GetAlternateRep	This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). (Inherited from SoNode.)
	GetBoundingBox	(Overrides SoNodeGetBoundingBox(SoGetBoundingBoxAction).)
	GetEventIn	Returns a the eventIn with the given name. (Inherited from SoFieldContainer.)
	GetEventOut	Returns the eventOut with the given name. (Inherited from SoFieldContainer.)
	GetField	Returns a the field of this object whose name is fieldName. (Inherited from SoFieldContainer.)
	GetFieldName	Returns the name of the given field in the fieldName argument. (Inherited from SoFieldContainer.)
	GetFields	Appends references to all of this object's fields to resultList, and returns the number of fields appended. (Inherited from SoFieldContainer.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetMatrix	(Overrides SoNodeGetMatrix(SoGetMatrixAction).)
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetPrimitiveCount	(Overrides SoNodeGetPrimitiveCount(SoGetPrimitiveCountAction).)
	GetRenderEngineMode	Returns the supported Render engine mode. (Inherited from SoNode.)
	GetRenderUnitID	(Inherited from SoNode.)
	GetSearchOK	Queries whether the search action will traverse the hidden children.
	GetStringName	(Inherited from SoBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GLRender	(Overrides SoNodeGLRender(SoGLRenderAction).)
	GLRenderBelowPath	(Inherited from SoNode.)
	GLRenderInPath	(Inherited from SoNode.)
	GLRenderOffPath	(Inherited from SoNode.)
	GrabEventsCleanup	(Inherited from SoNode.)
	GrabEventsSetup	(Inherited from SoNode.)
	HandleEvent	(Overrides SoNodeHandleEvent(SoHandleEventAction).)
	HasDefaultValues	Returns true if all of the object's fields have their default values. (Inherited from SoFieldContainer.)
	IsBoundingBoxIgnoring	This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored. (Inherited from SoNode.)
	IsNotifyEnabled	Notification is the process of telling interested objects that this object has changed. (Inherited from SoFieldContainer.)
	IsOverride	Returns the state of the override flag. (Inherited from SoNode.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	Pick	(Overrides SoNodePick(SoPickAction).)
	RayPick	(Inherited from SoNode.)
	Search	(Overrides SoNodeSearch(SoSearchAction).)
	Set	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. (Inherited from SoFieldContainer.)
	SetName	(Inherited from SoBase.)
	SetOverride	Turns the override flag on or off. (Inherited from SoNode.)
	SetSearchOK	If flag is true, the search action will traverse hidden children.
	SetSynchronizable	Sets this to be a ScaleViz synchronizable object. (Inherited from SoBase.)
	SetToDefaults	Sets all fields in this object to their default values. (Inherited from SoFieldContainer.)
	ToString	Converts this SoBase structure to a human readable string. (Inherited from SoBase.)
	Touch	Marks an instance as modified, simulating a change to it. (Inherited from SoNode.)
	Write	(Inherited from SoNode.)

Top

Properties

	Name	Description
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	name	Name of file from which to read children.
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)

Top

Remarks

This node represents a subgraph that was read from a named input file. When an OIV.Inventor.Nodes.SoFile node is written out, just the field containing the name of the file is written; no children are written out. When an OIV.Inventor.Nodes.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 OIV.Inventor.Nodes.SoFile.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 OIV.Inventor.SoInput), assuming the field isn't set to an absolute path name.

The children of an OIV.Inventor.Nodes.SoFile node are hidden; there is no way of accessing or editing them. If you wish to edit the contents of an OIV.Inventor.Nodes.SoFile node, you can modify the contents of the named file and then "touch" the OIV.Inventor.Nodes.SoFile.name field (see OIV.Inventor.Fields.SoField). Alternatively, you can use the OIV.Inventor.Nodes.SoFile.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

OIV.Inventor.Actions.SoGLRenderAction, OIV.Inventor.Actions.SoCallbackAction, OIV.Inventor.Actions.SoGetBoundingBoxAction, OIV.Inventor.Actions.SoGetMatrixAction, OIV.Inventor.Actions.SoHandleEventAction Traverses its children just as OIV.Inventor.Nodes.SoGroup does.

OIV.Inventor.Actions.SoRayPickAction Traverses its hidden children, but, if intersections are found, generates paths that end at the OIV.Inventor.Nodes.SoFile node.

OIV.Inventor.Actions.SoWriteAction Writes just the OIV.Inventor.Nodes.SoFile.name field and no children.

Reference

OIV.Inventor.Nodes Namespace

OIV.Inventor.SoInput

OIV.Inventor.SoPath