Implements file referencing for project management.
Class registration and implementation information is as follows:
| Category | Documentation |
|---|---|
| Implementation | C++ |
| Module | Plugin-Nodes-Project |
| Class Hierarchy | Node » Group » ConfigNode » FileConfigNode |
| Data Interface Name | FileConfigNode |
| Type Status | Active |
| Is Final Type | Yes |
Properties are as follows:
| Property | Documentation |
|---|---|
| Absolute Path | Enumerates the absolute path formed by this node and the accumulation of all parent nodes until it reaches any node that is not derived from ConfigNode. |
| Add To Installer | For installer use cases, this flag allows you to specify whether or not to add a file to an installer. |
| Exclude From Build | This flag is set to indicate that the document referred to by this node should be ignored by a build process of some kind. |
| Ignore During Dependency Recomputation | This flag is set to indicate that the document referred to by this node should be ignored during dependency recomputation. |
| Ignore During GUID Recomputation | This flag is set to indicate that the document referred to by this node should be ignored during GUID recomputation. |
| Ignore During Document Registration | This flag is set to indicate that the document referred to by this node should be ignored during document registration. |
| Is Project File | This flag is set to indicate that the document referred to by this node is a project file. |
Properties are as follows:
| Property | Documentation |
|---|---|
| Build Mode: Debug | Sets the application to build in debug mode. Note that this is just for the application and its UI. This does not build a binary debug build like you would build with a compiler. |
| Build Mode: Release | Sets the application to build in release mode. Note that this is just for the application and its UI. This does not build a binary release build like you would build with a compiler. |
| Show Information | Toggles information display during the application build process. Note that this refers to building the application shell, and any associated work, and does not refer to compiling the Simdify executable from source code. |
| Show Warnings | Toggles warning display during the application build process. Note that this refers to building the application shell, and any associated work, and does not refer to compiling the Simdify executable from source code. |
| In Personal | Obsolete. |
| In Professional | Obsolete. |
| In Enterprise | Obsolete. |
| Default Path: None | Disables this option. |
| Default Path: Application Binaries Path | When used as a folder, sets the folder's default path to the application binaries path. This path varies depending on where Simdify is installed, but it refers to a folder containing Simdify.exe and all DLLs used by the application. |
| Default Path: Application Data Path | When used as a folder, sets the folder's default path to the application data path. This path varies depending on where Simdify is installed, but it refers to a folder containing the primary Simdify installation, which includes the folder containing the application binaries, preferences folders, and other application data such as scripts. |
| Default Path: Application Documents Path | When used as a folder, sets the folder's default path to the application documents path. This path varies depending on where Simdify is installed, but it refers to a folder containing the primary Simdify installation, which includes the folder containing the Simdify document templates, sample documents, and texture data. |
| Default Path: Current Document Folders | When used as a folder, sets the folder's default path to the folder containing the document in which this node is resident. |
| BasePath | Sets the base containing folder. Usually this is something like C:\users\appdata\simdify\applications. |
| Relative Address From Document To Base Path | Sets or gets the relative path from the document location to the base path. This is almost always maintained by a Simdify application and should not need to be set by the user. |
| On Build Function | Specifies the name of a Simdify Scripting Language function that could be executed when the application is built. |
| Source Directory | The source directory path. When used, this should be a relative path from this document to a source directory. At present this option is not used during the application build process. |
| Destination Directory | The destination directory path. When used, this should be a relative path from this document to a destination directory. At present this option is not used during the application build process. |
Properties are as follows:
| Property | Documentation |
|---|---|
| Visible | Toggles the <Group>'s visible/invisible". Child nodes are not visible when their parent <Group>'s is invisible. |
| Collisions | Toggles collision detection on the <Group> node and its children". This is used for runtime export and has no effect in Simdify applications. |
| Cull | Toggles view volume culling on/off". modifying this parameter may cause incorrect culling and other unexpected consequences. |
| Preserve Camera | This option is undocumented at present. |
| Generic Data Source | This option provides the capability to connect a <Group>'s to a node that serves as a generic data source. |
| Bounding Box Frozen | Freezes the bounding box at its current size. This is often used as a runtime flag, and modifying this parameter may cause incorrect culling. |
| Minimum X | Displays the minimum bounding box coordinate on the X axis. |
| Minimum Y | Displays the minimum bounding box coordinate on the Y axis. |
| Minimum Z | Displays the minimum bounding box coordinate on the Z axis. |
| Maximum X | Displays the maximum bounding box coordinate on the X axis. |
| Maximum Y | Displays the maximum bounding box coordinate on the Y axis. |
| Maximum Z | Displays the maximum bounding box coordinate on the Z axis. |
| Transform Locked | Locks the node and prevents transformation of the node and its children. This is a runtime flag and has no effect in Simdify applications. |
| Position X | Displays the node's position on the X axis. |
| Position Y | Displays the node's position on the Y axis. |
| Position Z | Displays the node's position on the Z axis. |
| Orientation X | Displays the node's orientation on the X axis. |
| Orientation Y | Displays the node's orientation on the Y axis. |
| Orientation Z | Displays the node's orientation on the Z axis. |
| Scale X | Displays the node's scale on the X axis. |
| Scale Y | Displays the node's scale on the Y axis. |
| Scale Z | Displays the node's scale on the Z axis. |
| Billboard | Sets the node as a billboard. Billboards rotate to face the camera. This feature has been preserved for compatibility purposes, but this functionality should be implemented with geometry shaders. |
Properties are as follows:
| Property | Documentation |
|---|---|
| Name | Sets orthe name of the node. Do not use / or \ [forward slash and backslash] in the node name as this produces conflicts with resolving link nodes that reference external files. |
| Class | Sets the class of the node. |
| ID | Sets the ID of the node. This must be unique for each document, but different documents can use the same ID. |
| Export Disabled | Determines whether or not the node is exported during an export process, or possibly other purposes. This flag is set to No and current Simdify exporters ignore it (but it can be very useful if you need to modify the exporters). |
| Guid | Enumerates the Node's GUID. |