Changeset 548 for cpp/frams


Ignore:
Timestamp:
07/30/16 02:37:45 (8 years ago)
Author:
Maciej Komosinski
Message:

Improved description/docs

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpp/frams/model/geometry/modelgeoclass.cpp

    r286 r548  
    11// This file is a part of Framsticks SDK.  http://www.framsticks.com/
    2 // Copyright (C) 1999-2015  Maciej Komosinski and Szymon Ulatowski.
     2// Copyright (C) 1999-2016  Maciej Komosinski and Szymon Ulatowski.
    33// See LICENSE.txt for details.
    44
     
    1212{
    1313        { "Creature: Geometry", 1, 5, "ModelGeometry",
     14        "Approximately estimates sizes, volume, and area of a Model based on the geometry of its parts.\n"
    1415        "Example usage:\n"
    1516        "Simulator.print(ModelGeometry.forModel(Model.newFromString(\"//0\\np:sh=1\\n\")).area());\n\n"
    1617        "ModelGeometry.geom_density refers to the global simulator parameter (also available in GUI).\n"
    1718        "To set geom_density for individual ModelGeometry objects:\n"
    18         "var mg=ModelGeometry.forModel(GenePools[0][0].getModel()); mg.geom_density=2; GenePools[0][0].user1=mg.area();\n" },
     19        "var mg=ModelGeometry.forModel(GenePools[0][0].getModel()); mg.geom_density=2; GenePools[0][0].data->area=mg.area();\n" },
    1920        { "geom_density", 0, 0, "Density", "f 0.01 100.0 1.0", FIELD(density), "Affects the geometry calculation precision" }, //note: we used 'geom_density' instead of 'density' to make the name more unique - because sim_params merges all configuration fields in a single namespace.
    2021        { "forModel", 0, PARAM_USERHIDDEN, "", "p oModelGeometry(oModel)", PROCEDURE(p_formodel), "The returned ModelGeometry object can be used to calculate geometric properties (volume, area, sizes) of the associated model. The density is copied from the current global ModelGeometry.geom_density on object creation." },
Note: See TracChangeset for help on using the changeset viewer.