MAXScript Extensions > MAXScript Extensions for Particle Flow > Particle Flow Classes > Operators > Shape >

# ShapeLibrary : Helper

    shapeLibrary- superclass: helper super-superclass:node - classID:#(1395943169, 515064320)

Value > MAXWrapper > Node > Helper > shapeLibrary

| Particle Flow - Quick Navigation

Description:

ShapeLibrary is the default operator for defining the geometry used in the Particle Flow system since 3ds Max 2010. In version prior to 3ds Max 2010, the ShapeStandard Helper was performing this role.

Note

All primitive particles created by the Shape Library have pivot points in their geometric centers.

Constructor:

    shapeLibrary...

Properties:

    ShapeLibrary Dimension_Type : radiobtnIndex

Get/set the state of the Dimension Type radio button.

Possible values are:

0 - 2D Shapes

1 - 3D Shapes

    <ShapeLibrary>.'2D_Type' : integer

Get/set the selection of the 2D Shape Type drop-down list available when .Dimension_Type is set to 0.

Note

To specify a property starting with a digit, enclose the property name in single quotes.

This will avoid the "-- Compile error: Bad number or time syntax" error that would be thrown if the property name is specified without single quotes.

Possible values are:

0 - Circle 12-sided

1 - Circle 24-sided

2 - Diamond

3 - Digits Arial

4 - Digits Courier

5 - Digits Times

6 - Donut

7 - Heart

8 - Hexagon

9 - Letters Arial

10- Letters Courier

11- Letters Times

12- Notes

13- Pentagon

14- Square

15- Star 4-point

16- Star 5-point

17- Star 6-point

18- Star 8-point

19- Triangle (default)

    <ShapeLibrary>.'3D_Type' : integer

Get/set the selection of the 3D Shape Type drop-down list available when .Dimension_Type is set to 1.

Note

To specify a property starting with a digit, enclose the property name in single quotes.

This will avoid the "-- Compile error: Bad number or time syntax" error that would be thrown if the property name is specified without single quotes.

Possible values are:

0 - Cube (default)

1 - Diamond

2 - Diamond Long

3 - Digits Arial

4 - Digits Courier

5 - Digits Times

6 - Dodecahedron

7 - Heart

8 - Letters Arial

9- Letters Courier

10- Letters Times

11- Notes

12- Pyramid

13- Special

14- Sphere 20-sides

15- Sphere 80-sides

16- Star 5-point

17- Star 6-point

18- Tetra

19- Torus

    <ShapeLibrary>.Size : worldUnits

Get/set the Size of the shape.

    <ShapeLibrary>.Use_Scale : boolean

Get/set the state of the Scale checkbox.

When set to True, the scale value will be applied to the Particle Scale channel, modifying the final size of the particle in the viewport and renderer.

    <ShapeLibrary>.Scale_Value (Scale) : percent

Get/set the Scale value. When .Use_Scale is set to True, the scale value will be applied to the Particle Scale channel, modifying the final size of the particle in the viewport and renderer.

    <ShapeLibrary>.Scale_Variation : percent

Get/set the Scale Variation value.

When .Use_Scale is set to True, the scale value will be changed randomly using the Scale Variation value to produce random values which will be applied to the Particle Scale channel, thus modifying the final size of the particle in the viewport and renderer.

    <ShapeLibrary>.Random_Multi_Shape_Order : boolean

Get/set the state of the Multi-Shape Random Order option.

When set to True, multi-shape shapes will be applied randomly.

When set to False, they will be applied in order. Multi-Shapes are for example the Digits and Letters.

Thus, if the option is set to False and a Digits shape is selected, particles will get shapes in the order 0,1,2,3,4,5,6,7,8,9. If the option is True, the shapes will be assigned randomly based on the Random_Seed value, for example 5,8,2,9,1,3,7,4,6,0

    <ShapeLibrary>.Random_Seed : integer

Get/set the Random Seed value used to control the random number generation in the Shape Helper, including the Scale Variation and the Multi-Shape Random Order.

    <ShapeLibrary>.Generate_Mapping_Coords : boolean

Get/set the state of the Generate Mapping Coords. option.

When set to True, UV coordinates will be generated by the Shape, allowing the texture mapping of the shape geometry.

When set to False (default), the whole shape will use the particle mapping coordinates (if any), resulting inconstant UV values throughout the shape's vertices.

    <ShapeLibrary>.Fit_Mapping : boolean

Get/set the state of the Fit Mapping option.

When set to True (default) and .Generate_Mapping_Coords is also set to True, the mapping will be set to fit the geometry.

## shapeStandard Interfaces:

Interface: action

Interface: operator

Interface: PViewItem

#### See Also

- Shape_Facing : Helper

- Shape_Instance : Helper

- Shape_Mark : Helper

- shapeStandard : Helper

- Particle Flow Classes