Overview | Package contents | Plugins interfaces | Working with LOD utilities | Setting properties | General properties | Group properties | LOD properties | Polygonal object properties | Sprite properties


Overview

Plugins are used for adding parameters used by Alternativa engine into the modeling environment and provide the ability to set basic properties directy in 3ds max. This eliminates the need to specify these settings in your application code.

Collada extension is the format of the models, storing all these properties.

Package Contents
Package includes 4 modules: A3DCOLLADAMAX, A3DPARAMSGUP, A3DLOD, A3DSPRITE.
Plugins interfaces
Plugins can be found (discovered) in several places in 3ds max:

1. Create object dialog will have new group "Alternativa", which includes 2 object types: LOD, Sprite.

2. New object rollouts will appear depending on selected object type, see more in setting properties for objects section.

3. Two additional rollouts can be enabled for LODs in utilities tab

4. New format appears in export menu.

Working with LOD utilities

Special utilities making work with lods more convenient can be found in Utilities pane.

LOD's distance editor

The utility is desiged for setting levels of detail for the distances to multiple LODContainers (simultaneously).

Each distance field corresponds to level of detail according to order they are set in the list of LODContainer. Set button applies distances to appropriate levels of detalization entered in fields. After the set button is pressed lod's children will be resorted according to distance. Distance will not be changed If 0 value is set for the level. The distance for level of detail more than 5 can be set by entering number and distance in level and distance fields. If Only selected flag is set, changes will be applied only to selected lods.

LOD's level selector

LOD's level selector is designed for changing current level of detail for all lod-containers at once.

Number of level for selection is entered into the Level field. Select button selects entered level.

Level numbering starts from 1. If entered number is larger than lod's children count, the last child would be selected.

Setting properties
All properties, available for storing in model file and loading to Alternativa, are present in additional property rollouts of selected object. The set of properties varies for different types of objects (mesh, container, LOD and sprite). As all these types in Alternativa are inherited from one base class Object3d, there is list of general (common) properties available for all types of objects.
General properties

General (common) properties for all types of objects



  Property Defined By
    alpha
Alpha transparency value.
CommonHelp
    blendmode
A value from the flash. Blending mode of the object.
CommonHelp
Property Detail
alpha property
alpha  

Alpha transparency value. Alpha transparency value. Valid values are 0 to1. Default value is 1.



See also

blendmode property  
blendmode  

A value from the flash. Blending mode of the object. A value from the flash.display.BlendMode class that specifies which blend mode is recomended to use.



See also





Group properties

Groups in 3ds max turn into containers in Alternativa. Available group properties are:



  Property Defined By
    aabb
Property in classes alternativa.engine3d.objects.BSP, alternativa.engine3d.objects.KD and alternativa.engine3d.objects.Conflict. Flag of child objects partition by planes created through AABB (axis aligned bound box) object sides. Default value is true.
ContainerHelp
    clipping
Property in class alternativa.engine3d.objects.BSP Object clipping mode by camera frustum.
ContainerHelp
    ContainersType
Container type, which handles parsed group in Alternativa
ContainerHelp
    oobb
Property in classes alternativa.engine3d.objects.BSP, alternativa.engine3d.objects.KD and alternativa.engine3d.objects.Conflict. Flag of child objects partition by planes created through OOBB (object oriented bound box) object sides. Default value is true.
ContainerHelp
    sortByZ
Property in class distanceContainer
ContainerHelp
    threshold
Property in classes alternativa.engine3d.objects.BSP, alternativa.engine3d.objects.KD and alternativa.engine3d.objects.Conflict.
ContainerHelp
Property Detail
aabb property
aabb  

Property in classes alternativa.engine3d.objects.BSP, alternativa.engine3d.objects.KD and alternativa.engine3d.objects.Conflict.

Flag of child objects partition by planes created through AABB (axis aligned bound box) object sides. Default value is true.



clipping property  
clipping  

Property in class alternativa.engine3d.objects.BSP

Object clipping mode by camera frustum. You can use following constants of Clipping class: Clipping.BOUND_CULLING, Clipping.FACE_CULLING, Clipping.FACE_CLIPPING. Default value is Clipping.FACE_CLIPPING.



ContainersType property  
ContainersType  

Type of container which handles parsed group in Alternativa



oobb property  
oobb  

Property in classes alternativa.engine3d.objects.BSP, alternativa.engine3d.objects.KD and alternativa.engine3d.objects.Conflict.

Flag of child objects partition by planes created through OOBB (object oriented bound box) object sides. Default value is true.



sortByZ property  
sortByZ  

Property in class distanceContainer. Determines if objects would be sorted by full distance to camera or by Z-distance in camera space only. Default value is false.



threshold property  
threshold  

Property in classes alternativa.engine3d.objects.BSP, alternativa.engine3d.objects.KD and alternativa.engine3d.objects.Conflict. Geometrical threshold.







LOD properties

See also

alternativa.engine3d.containers.LODContainer


  Property Defined By
    CenterAlignChild : *
If checked, after adding model into LOD it would be moved to center coordinates of LOD.
LODHelp
    Distance : *
Sets current child object distance.
LODHelp
    PickObjects : *
Turns on adding children into LOD mode. When button is pressed, clicks on the objects in 3Ds max will place them into LOD.
LODHelp
Property Detail
CenterAlignChild : property
CenterAlignChild :

If checked, after adding model into LOD it would be moved to center coordinates of LOD.



Distance : property  
Distance:*  

Sets current child object distance.



See also

PickObjects property  
PickObjects:*  

Turns on adding children into LOD mode. When button is pressed, clicks on the objects in 3Ds max will place them into LOD. Second press turns this mode off.







Polygonal objects properties



  Property Defined By
    baseGeometry
If flag is set, creation of BSP-tree will use object for default geometry (parameter sourceGeometry in BSPContainer.createTree method)
MeshHelp
    clipping
Object clipping mode by camera frustum.
MeshHelp
    optimize
Only for staticBSP and dynamicBSP sorting
MeshHelp
    sorting
Faces sorting mode.
MeshHelp
    splitter
If flag is set, creation of BSP-tree will use object as splitter (parameter sourceSplitters in BSPContainer.createTree method)
MeshHelp
    threshold
Only for staticBSP and dynamicBSP sorting. Geometrical threshold.
MeshHelp
Property Detail
baseGeometry property
baseGeometry  

If flag is set, creation of BSP-tree will use object for default geometry (parameter sourceGeometry in BSPContainer.createTree method)



See also

alternativa.engine3d.loaders.collada.ParserCollada.getBspContainerChildType
clipping property  
clipping  

Object clipping mode by camera frustum. You can use following constants of Clipping class for setting clipping property: Clipping.BOUND_CULLING, Clipping.FACE_CULLING, Clipping.FACE_CLIPPING. Default value is Clipping.FACE_CLIPPING.



See also

optimize property  
optimize  

Only for staticBSP and dynamicBSP sorting



See also

sorting property  
sorting  

Faces sorting mode. You can use following constants of Sorting class for setting sorting property: Sorting.NONE, Sorting.AVERAGE_Z, Sorting.DYNAMIC_BSP. Default value is Sorting.AVERAGE_Z.



See also

splitter property  
splitter  

If flag is set, creation of BSP-tree will use object as splitter (parameter sourceSplitters in BSPContainer.createTree method)



See also

alternativa.engine3d.loaders.collada.ParserCollada.getBspContainerChildType()
threshold property  
threshold  

Only for staticBSP and dynamicBSP sorting

Geometrical threshold. It is small quantity where it is possible not to take into account values difference. It is used for building temporary BSP-tree in sorting mode Sorting.DYNAMIC_BSP. Default value is 0.01.



See also





Sprite properties



  Property Defined By
    autoSize
If true and the texture is set, the size of sprite is synchronized with texture size.
SpriteHelp
    clipping
Object clipping mode by camera frustum.
SpriteHelp
    height
Sprite height.
SpriteHelp
    originX
X coordinate of the origin point.
SpriteHelp
    originY
Y coordinate of the origin point.
SpriteHelp
    perspectiveScale
Perspective scale option.
SpriteHelp
    rotation
Rotation angle.
SpriteHelp
    sorting
Faces sorting mode.
SpriteHelp
    width
Sprite width.
SpriteHelp
Property Detail
autoSize property
autoSize  

If true and the texture is set, the size of sprite is synchronized with texture size. Default value is false.



See also

clipping property  
clipping  

Object clipping mode by camera frustum. You can use following constants of Clipping class for setting clipping property: Clipping.BOUND_CULLING, Clipping.FACE_CULLING, Clipping.FACE_CLIPPING. Default value is Clipping.FACE_CLIPPING.



See also

height property  
height  

Sprite height.



See also

originX property  
originX  

X coordinate of the origin point. Can be from 0 to 1. Default value is 0.5.



See also

originY property  
originY  

Y coordinate of the origin point. Can be from 0 to 1. Default value is 0.5.



See also

perspectiveScale property  
perspectiveScale  

Perspective scale option. If false, size of sprite will be the same regardless of distance to camera. Default value is true.



See also

rotation property  
rotation  

Rotation angle (in radians).



See also

sorting property  
sorting  

Faces sorting mode. You can use following constants of Sorting class for setting sorting property: Sorting.NONE, Sorting.AVERAGE_Z, Sorting.DYNAMIC_BSP. Default value is Sorting.AVERAGE_Z.



See also

width property  
width  

Sprite width.



See also