GrowFX 2.0 User Manual

MAXScript Access

Constructor:

growfx ...
An example:

gfx = growfx name:"Tree_01" position:[10,10,0]


MAXScript properties and methods for GrowFX Full and Demo versions

Properties:

<growfx>.LineOnly : Boolean default: true
<growfx>.Manual : Boolean default: false
<growfx>.IconSize : Float default: 0.0
<growfx>.Seed : Integer default: (random value)
<growfx>.CountPath : Integer : Read only
<growfx>.GfxFileName : String
<growfx>.ShowLineNumbers : Boolean default: false
<growfx>.ShowLineFullNumbers : Boolean default: false

Preference parameters:
<growfx>.UnitCalc : Float default: 10.0
<growfx>.DisableAllMetaMeshes : Boolean default: false
<growfx>.VectorsSize : Float default: 10.0
<growfx>.ShowEdges : Boolean default: true
<growfx>.SelectionMesh : Boolean default: true
<growfx>.HideIcon : Boolean default: false
<growfx>.RandomWireColor : Boolean default: true
<growfx>.PathSegsLimit : Integer default: 1000
<growfx>.DensityLimit : Integer default: 1000
<growfx>.DistrCountLimit : Integer default: 1000
<growfx>.MeshSegsLimit : Integer default: 1000
<growfx>.MetaVertsLimit : Integer default: 100000

Global Meta Settings:
<growfx>.MetaSettings_MaxIterations : Integer default: 10000
<growfx>.MetaSettings_MinSizeFaces : Float default: 0.005
<growfx>.MetaSettings_GenerateUVWMapping : Boolean default: true
<growfx>.MetaSettings_RebuildExtralargeFaces : Boolean default: false
<growfx>.MetaSettings_RebuildExtrasmallFaces : Boolean default: false


Methods:

SavePreset <pathfile_name_string>
LoadPreset <pathfile_name_string>

Save and Open preset files.


Update()

Updates the GrowFX internal caches and viewport display to account for all the changes made by other functions in this kit.


NewSeed()

Generate a new random seed.


getNumSequences()

Returns the number of sequences. It equals the number of objects that are used in the distributors (the GrowFX icon, points, surfaces, etc.).


getNumLines <sequence_index_integer>

Returns the number of lines for the specified sequence, index are 1-based.


GenerateOneMesh <sequence_index_integer> <line_index_integer>

After calling this function, GrowFX generates a mesh for only the specified line, indexes are 1-based.


ResetOneMesh()

Resets the state of the previous function.


CreateSeparateSplines()

Creates separate splines for each path line. This method does not working in the Demo version!


SetCopyright <copyright_string> <url_string> <password_string> <is_Lock_NodeGraph_Boolean>

Sets your own Copyright. For more information see Abouts rollout.

<url_string> must include protocol "http:\\" or "https:\\".


For example:

gfx.SetCopyright "My Name" "https:\\example.com" "1234" true



Cache Mode Properties

<growfx>.CacheMode : Boolean default: false
<growfx>.CacheFileName : String : Read only
<growfx>.NumThreads : Integer default: (number of cores on the current PC)
<growfx>.RecordCurrentFrame : Boolean default: false
<growfx>.RecordAnimation : Boolean default: true
<growfx>.CacheStartFrame : Timevalue default: 0
<growfx>.CacheEndFrame : Timevalue default: 100
<growfx>.PlaybackStartFrame : Timevalue default: 0
<growfx>.PlaybackSpeedFactor : Float default: 1.0
<growfx>.PlaybackLoopAnimation : Boolean default: true

Cache Mode methods:

NewCacheFile <string_path_filename>

Specifies the name of the new cache file. Returns true if the file was successfully prepared, false if it failed.


LoadCacheFile <string_path_filename>

Loads the specified cache file. Returns true if the cache file was found and loaded successfully.


RecordCache()

Records the cache data of the given GrowFX object to the disk.


ResetCache()

Resets the cache data.


DeleteCache()

Deletes the cache file from the disk.




MAXScript properties and methods for GrowFX Rendernode version

Properties:

<growfx>.LineOnly : Boolean default: true
<growfx>.Manual : Boolean default: false
<growfx>.IconSize : Float default: 0.0
<growfx>.Seed : Integer default: (random value)

Methods:

Update()

Updates the GrowFX internal caches and viewport display to account for all the changes made by other functions in this kit.


Cache Mode Properties

<growfx>.CacheMode : Boolean default: false
<growfx>.CacheFileName : String : Read only
<growfx>.PlaybackStartFrame : Timevalue default: 0
<growfx>.PlaybackSpeedFactor : Float default: 1.0
<growfx>.PlaybackLoopAnimation : Boolean default: true

Cache Mode methods:

LoadCacheFile <string_path_filename>

Loads the specified cache file. Returns true if the cache file was found and loaded successfully.


ResetCache()

Resets the cache data.


DeleteCache()

Deletes the cache file from the disk.



TOP