Skip to content

Settings Generator

naraesk edited this page Mar 5, 2019 · 1 revision

This page is out of date! It applies only to generator but not to generator2.



General Settings

key Values Description
output_format x3d | x3dom | x3d_compressed | aframe | simple_glyphs_json
database_name ../databases/graph.db
structure.merge_packages true | false
structure.master_root true | false Create one artificial root package which contains all the other root packages
structure.hide_private_elements true | false If set true all private elements will not be shown in visualization.
This includes methods, attributes and structures
structure.attribute_sort_size true | false If set true attributes will be sorted lengthwise, longest value first in descending order
structure.parser verveinej | jdt2famix The parser that created the famix model
history.show_histories true | false
history.repository_name String
history.repository_owner String

City Settings

key Values Description
city.building_type original | panels | bricks | floor | dynamic
city.scheme types | visiblity The active mode to structure and color the methods and attributes.
types: The class elements are sorted and colored associated to type/functionality of the method.
visibility: The class elements are sorted and colored corresponding to there visibility modifiers.
city.class_elements_mode methods_and_attributes | methods_only | attributes_only Switch to control the elements of the classes to show
city.class_elements_sort_mode_coarse methods_first | unsorted | attributes_first
city.class_elements_sort_mode_fine scheme | unsorted | alphabetically | nos The active mode, how to sort the methods or attributes separately among each other.
This means a method is only compared to another method and an attribute is only
compared to another attribute in this comparison, according their values.
If it is set to scheme, a secondary sorting is performed to place methods
with high numbers of statements to the bottom.
city.class_elements_sort_mode_fine_direction_reversed true | false If set true, the order of the sorting, defined in class_elements_sort_mode_fide is reversed.
If class_elements_sort_mode_fide is set to scheme, a secondary sorting is performed to place
#methods with high numbers of statements to the bottom. This behavior isn’t influenced by this switch.
city.show_building_base true | false Switch to show or hide building base in panels or bricks mode.
If set to false, only districts and buildingSegments are visible.
city.show_attributes_as_cylinders true | false Switch for showing attributes as cylinders instead of boxes.
This setting has only an affect in panels-mode.
city.brick.layout progressive | straight | balanced The active mode for the layout of the bricks/methods.
This setting has only an affect in brick-mode.
city.brick.size 1.0 | Double
city.brick.horizontal_margin 0.5 | Double
city.brick.horizontal_gap 0.2 | Double
city.brick.vertical_margin 0.2 | Double
city.brick.vertical_gap 0.2 | Double
city.panel.separator_mode separator | none | gap The active mode for the area between panels/methods
city.panel.height_treshold_nos 3, 6, 12, 24, 48, 96, 144, 192, 240 Multiplier for height of a panel, declared in panel.height_unit. The elements of this array are threshold values for the number of statements inside the method and are multiplied with the index+1, so the product will be the actual height of the panel.
city.panel.height_unit 0.5 | Double Height is multiplied by city.panel.height_treshold_nos
city.panel.horizontal_margin 0.5 | Double
city.panel.vertical_margin 0.25 | Double
city.panel.vertical_gap 0.125 | Double
city.panel.separator_height 0.125 | Double
city.original_building_metric none | nos
city.width_min 1 | Double
city.height_min 1 | Double
city.building.horizontal_margin 3.0 | Double
city.building.horizontal_gap 3.0 | Double
city.building.vertical_margin 1.0 | Double
city.package.color_start #969696 | Hex Color
city.package.color_end #f0f0f0 | Hex Color
city.class.color_start #131615 | Hex Color
city.class.color_end #00ff00 | Hex Color
city.class.color #353559 | Hex Color
city.dynamic.class.color_start #fa965 | Hex Color
city.dynamic.class.color_end #feb280 | Hex Color
city.dynamic.method.color #735eb9 | Hex Color
city.dynamic.package.color_start #23862c | Hex Color
city.dynamic.package.color_end #7bcd8d | Hex Color
city.color.blue #99FFCC | Hex Color
city.color.aqua #99CCFF | Hex Color
city.color.light_green #CCFF99 | Hex Color
city.color.dark_green #99FF99 | Hex Color
city.color.yellow #ffff99 | Hex Color
city.color.orange #FFCC99 | Hex Color
city.color.red #FF9999 | Hex Color
city.color.pink #FF99FF | Hex Color
city.color.violet #9999FF | Hex Color
city.color.light_grey #CCCCCC | Hex Color
city.color.dark_grey #999999 | Hex Color
city.color.white #FFFFFF | Hex Color
city.color.black #000000 | Hex Color

Recursive Disk Settings

key Values Description
rd.data_factor 4.0 | Double
rd.method_factor 1.0 | Double
rd.height 1.0 | Double
rd.height_boost 1.0 | Double
rd.height_multiplicator 50.0 | Double
rd.ring_width 2.0 | Double
rd.ring_width_md 0 | Double Sets the ring width of the method disks. Only relevant if disk of type FAMIX.Method exist
rd.ring_width_ad 0 | Double Equally to rd.ring_width_md but for attribute disks
rd.min_area 10.0 | Double
rd.namespace_transparency 0 | Double
rd.class_transparency 0 | Double
rd.method_transparency 0 | Double
rd.data_transparency 0 | Double
rd.color.class #353559 | Hex Color
rd.color.data #fffc19 | Hex Color
rd.color.method #1485cc | Hex Color
rd.color.namespace #969696 | Hex Color
rd.color.method_invocation #780a320 | Hex Color
rd.method_disks true | false If true the Methods will be visualized as Disks instead of DiskSegments
rd.data_disks true | false If true Attributes will be visualized as disks
rd.method_type_mode true | false If true visualization will be based on the method type
rd.metric_representation none | height | luminance | frequency Depending on the value set metrics will not represented, by height or in a dynamic way which can either be luminance or frequency.
rd.invocation_representation none | moving_spheres | flashing_methods | moving_flashing
rd.evolution_representation time_line | dynamic_evolution | multiple_time_line | multiple_dynamic_evolution Sets in which way the Historic Evolution of the analyzed Software should be represented, it can either be in a static or dynamic way.
rd.variant static | dynamic

Plant Settings

key Values Description
plant.switch_attribute_method_mapping petal_pollstem | pollstem_petal
plant.area_height 3.5 | Double
plant.stem.thickness 3.0 | Double
plant.stem.height 6.0 | Double
plant.cron.height 2.0 | Double
plant.cron.head_height 0.5 | Double
plant.petal.angle 0.5236 | Double
plant.petal.distance_multiplier 3.0 | Double
plant.pollstem.angle 0.05 | Double
plant.pollstem.angle_distance_multiplier 0.3 | Double
plant.pollstem.ball_multiplier 1.57 | Double
plant.junction.angle 1.3 | Double
plant.junction.distance_multiplier 8.0 | Double
plant.junction.pollstem.ball_multiplier 0.10 | Double
plant.width_min 1.0 | Double
plant.height_min 1.0 | Double
plant.building.horizontal_margin 3.0 | Double
plant.building.horizontal_gap 7.0 | Double
plant.building.vertical_margin 1.0 | Double
plant.package.shape default | cylinder
plant.package.use_textures true | false
plant.package.odd_texture <ImageTexture url=‘pics/ground.png’ scale=‘false’ />
plant.package.even_texture <ImageTexture url=‘pics/freeGrass.png’ scale=‘false’ />
plant.package.odd_color #964327 | Hex Color
plant.package.even_color #30ba43 | Hex Color
plant.class.shape default | realistic | without_head
plant.class.size count_attributes_and_methods
plant.class.use_textures true | false
plant.class.textures <ImageTexture url=‘pics/plant.png’ scale=‘true’ />
plant.class.texture_head_brown <ImageTexture url=‘pics/plantHeadBrown.png’ scale=‘false’ />
plant.class.texture_bloom <ImageTexture url=‘pics/bloom.png’ scale=‘false’ />
plant.class.color #34663b | Hex Color
plant.class.color02 #8b4413 | Hex Color
plant.class.color03 #ffff00 | Hex Color
plant.inner_class.shape default | realistic
plant.inner_class.use_textures true | false
plant.inner_class.texture <ImageTexture url=‘pics/plant.png’ scale=‘true’ />
plant.inner_class.texture_junction_head_top_part <ImageTexture url=‘pics/junctionHeadTopPart.png’ scale=‘false’ />
plant.inner_class.texture_bloom <ImageTexture url=‘pics/bloom.png’ scale=‘false’ />
plant.inner_class.color #329c3c | Hex Color
plant.inner_class.color02 #8b4413 | Hex Color
plant.inner_class.color03 #ffff00 | Hex Color
plant.attribute.shape realistic_petal | default | default_with_cylinder
plant.attribute.show true | false
plant.attribute.use_textures true | false
plant.attribute.texture <ImageTexture url=‘pics/lilacPetal.png’ scale=‘false’ />
plant.attribute.color #8a3398 | Hex Color
plant.inner_class_attribute.shape realistic_petal | default | default_with_cylinder
plant.inner_class_attribute.texture <ImageTexture url=‘pics/lilacPetal.png’ scale=‘false’ />
plant.inner_class_attribute.color #ab2626 | Hex Color
plant.method.shape default | stick | sphere | pollpetal
plant.method.show true | false
plant.method.use_textures true | false
plant.method.texture <ImageTexture url=‘pics/junctionGreen.png’ scale=‘false’ />
plant.method.texture_pollball <ImageTexture url=‘pics/pollball.png’ scale=‘false’ />
plant.method.color #00FF00 | Hex Color
plant.method.color02 #FFFF00 | Hex Color
plant.inner_class_method.shape default | stick | sphere | pollpetal
plant.inner_class_method.texture <ImageTexture url=‘pics/bloom.png’ scale=‘false’ />
plant.inner_class_method.color #8b4413 | Hex Color