Interface: FlightStudio

Interfaces > Core Interfaces > FlightStudio

 

   

Core Interfaces - Quick Navigation

The FlightStudio Core Interface available in 3ds Max 2010 and higher exposes properties and methods related to the Flight Studio extension.

NOTE:

Flight Studio ships with a Flight Studio Tools script located in the scripts\FlightStudio folder.

It can be used as a comprehensive example of the usage of the following properties and methods!

   

Properties:

FlightStudio.OverrideColors : integer : Read 	 

   

FlightStudio.OverrideMaterials : integer : Read   

   

FlightStudio.OverrideTextures : integer : Read 

   

FlightStudio.OverrideLineStyles : integer : Read 

   

FlightStudio.OverrideSounds : integer : Read 

   

FlightStudio.OverrideLightSources : integer : Read 

   

FlightStudio.OverrideLightPoints : integer : Read 

   

Methods:

Browser

<void>FlightStudio.Browser() 

Opens the Flight Studio browser. Equivalent to pressing the "Modify Hierarchy/Attributes" button in the Flight Studio utility.

   

<void>FlightStudio.RefreshBrowser() 

Refreshes the browser. Equivalent to pressing the "Refresh" button in the Flight Studio browser.

   

Level Of Detail

<void>FlightStudio.LodMoreDetail() 

Increases the Level Of Detail. Equivalent to pressing the "More Detail" button in the Flight Studio utility.

   

<void>FlightStudio.LodMostDetail() 

Increases the Level Of Detail to the maximum. Equivalent to pressing the "Most Detail" button in the Flight Studio utility.

   

<void>FlightStudio.LodLessDetail() 

Decreases the Level Of Detail. Equivalent to pressing the "Less Detail" button in the Flight Studio utility.

   

<void>FlightStudio.LodLeastDetail() 

Decreases the Level Of Detail to the minimum. Equivalent to pressing the "Least Detail" button in the Flight Studio utility.

   

<float>FlightStudio.GetLodDistance() 

Returns the Level Of Detail Distance value.

   

<void>FlightStudio.SetLodDistance <float>LodDistance 

Sets the Level Of Detail Distance value to the given floating point number.

   

<boolean>FlightStudio.IsLodDistanceSet() 

Returns true if the Level Of Detail Distance has been set, false otherwise.

   

Creation

<boolean>FlightStudio.CreateGroup() 

Creates a Group node in the hierarchy.

Equivalent to setting the drop-down list in the Flight Studio browser to "Group" and pressing the "Create" button.

Returns true on success, false on failure.

   

<boolean>FlightStudio.CreateObject() 

Creates an Object node in the hierarchy.

Equivalent to setting the drop-down list in the Flight Studio browser to "Group" and pressing the "Create" button.

Returns true on success, false on failure.

   

<boolean>FlightStudio.CreateSwitch() 

Creates an Switch node in the hierarchy.

Equivalent to setting the drop-down list in the Flight Studio browser to "Switch" and pressing the "Create" button.

Returns true on success, false on failure.

   

<boolean>FlightStudio.CreateLOD() 

Creates an LOD node in the hierarchy.

Equivalent to setting the drop-down list in the Flight Studio browser to "Group" and pressing the "Create" button.

Returns true on success, false on failure.

   

<boolean>FlightStudio.CreateDOF() 

Creates an DOF node in the hierarchy.

Equivalent to setting the drop-down list in the Flight Studio browser to "DOF" and pressing the "Create" button.

Returns true on success, false on failure.

   

<boolean>FlightStudio.CreateBSP() 

Creates an BSP node in the hierarchy.

Equivalent to setting the drop-down list in the Flight Studio browser to "BSP" and pressing the "Create" button.

Returns true on success, false on failure.

   

<boolean>FlightStudio.CreateClipRegion() 

Creates an Clip Region node in the hierarchy.

Equivalent to setting the drop-down list in the Flight Studio browser to "Clip region" and pressing the "Create" button.

Returns true on success, false on failure.

   

<boolean>FlightStudio.CreateExternalRef() 

Creates an XRef node in the hierarchy.

Equivalent to setting the drop-down list in the Flight Studio browser to "XRef" and pressing the "Create" button.

Returns true on success, false on failure.

   

<boolean>FlightStudio.CreateLightPoint() 

Creates an Light Point node in the hierarchy.

Equivalent to setting the drop-down list in the Flight Studio browser to "Light point" and pressing the "Create" button.

Returns true on success, false on failure.

   

Comments

<string>FlightStudio.GetComment <node>Node 

Returns the comment for the given node.

   

<boolean>FlightStudio.PutComment <node>Node <string>String 

Sets the comment for the specified node to the given string value.

   

Data Access

<boolean>FlightStudio.HasData <node>node 

Returns true if the specified node has data, false otherwise.

   

<boolean>FlightStudio.CopyData <node>srcnode <node>dstnode 

Copies the data from the source node to the destination node.

Returns true on success, false on failure.

   

<boolean>FlightStudio.RemoveData <node>node 

Removes the data from the given node.

Returns true on success, false on failure.

   

Texture Attributes

<boolean>FlightStudio.AddTextureAttr <texturemap>Texmap 

Adds the given texture as attribute.

Returns true on success, false on failure.

   

<boolean>FlightStudio.RemoveTextureAttr <texturemap>Texmap 

Removes the given texture attribute.

Returns true on success, false on failure.

   

External References

<string>FlightStudio.GetExternalRefFilename <node>Node 

Returns the external reference file name of the given node.

   

<boolean>FlightStudio.PutExternalRefFilename <node>Node <string>String 

Sets the external reference file name of the given node to the specified string.

   

<integer>FlightStudio.GetExternalRefFlags <node>Node 

Returns the external reference flags of the given node as an integer.

   

<boolean>FlightStudio.PutExternalRefFlags <node>Node <integer>Flags 

Sets the external reference flags of the given node to the specified integer.

   

Other Methods

<string>FlightStudio.GetLastImport() 

Returns the file name of the last imported Flight Studio FLT file.

   

<boolean>FlightStudio.IsOfType <node>Node <string>String 

Returns true if the given node is of the type specified by the second string argument, false if it is not.

   

<boolean>FlightStudio.SetKeepTriangles <node>Node <boolean>Flag 

Sets the Keep Triangles flag of the given node to the specified Boolean value.

Returns true on success, false on failure.

   

<boolean>FlightStudio.GetKeepTriangles <node>Node 

Returns the Keep Triangles flag of the given node as a Boolean value.

   

See Also