Curvy  7.1.0
CGBoundsGroup Class Reference
+ Inheritance diagram for CGBoundsGroup:
+ Collaboration diagram for CGBoundsGroup:

Detailed Description

Helper class used by VolumeSpots and others

Public Types

enum  RotationModeEnum { Full, Direction, Horizontal, Independent }
 How the rotation axes are defined related to the Volume's data More...
 

Properties

FloatRegion CrossBase [get, set]
 Shifts the Cross origin for this group by a value in the defined range More...
 
int FirstRepeating [get, set]
 First index of the RepeatingItems range More...
 
bool IgnoreModuleCrossBase [get, set]
 If true, the Cross origin for this group will not take into consideration the Cross parameters of the BuildVolumeSpots class/> More...
 
int ItemCount [get]
 
List< CGBoundsGroupItemItems [get]
 
bool KeepTogether [get, set]
 When true, the group will only be placed when all items can be placed in the space left. More...
 
int LastRepeating [get, set]
 Last index of the RepeatingItems range More...
 
string Name [get, set]
 
bool RandomizeItems [get, set]
 When enabled, items in groups will be selected randomly.

See also
RepeatingItems
More...
 
bool RelativeTranslation [get, set]
 When true, the translation of an item is done in the relative frame defined by the tangent and orientation (up vector) of the volume at the item's position More...
 
IntRegion RepeatingItems [get, set]
 When

See also
RandomizeItems

is set to true, the randomized items are the the ones that have their indices inside the RepeatingItems range More...

 
RotationModeEnum RotationMode [get, set]
 How the rotation axes are defined related to the Volume's data More...
 
FloatRegion RotationX [get, set]
 
FloatRegion RotationY [get, set]
 
FloatRegion RotationZ [get, set]
 
FloatRegion ScaleX [get, set]
 
FloatRegion ScaleY [get, set]
 
FloatRegion ScaleZ [get, set]
 
FloatRegion SpaceAfter [get, set]
 
FloatRegion SpaceBefore [get, set]
 
FloatRegion TranslationX [get, set]
 
FloatRegion TranslationY [get, set]
 
FloatRegion TranslationZ [get, set]
 
bool UniformScaling [get, set]
 When true, the scaling vector is (ScaleX, ScaleX, ScaleX) instead of (ScaleX, ScaleY, ScaleZ) More...
 
- Properties inherited from CGWeightedItem
float Weight [get, set]
 

Public Member Functions

 CGBoundsGroup (string name)
 
void ConvertObsoleteData ()
 Converts the obsolete data to the new format More...
 

Static Public Member Functions

static void FillItemBag (WeightedRandom< int > bag, IEnumerable< CGWeightedItem > itemsWeights, int firstItem, int lastItem)
 Fill an item bag with items based on their weights More...
 

Member Enumeration Documentation

enum RotationModeEnum
strong

How the rotation axes are defined related to the Volume's data

Enumerator
Full 

Use Volume's direction and orientation

Direction 

Use Volume's direction only

Horizontal 

Use Volume's direction only after projecting it on XZ plane

Independent 

Do not use Volume's data

Constructor & Destructor Documentation

CGBoundsGroup ( string  name)

Member Function Documentation

void ConvertObsoleteData ( )

Converts the obsolete data to the new format

static void FillItemBag ( WeightedRandom< int >  bag,
IEnumerable< CGWeightedItem itemsWeights,
int  firstItem,
int  lastItem 
)
static

Fill an item bag with items based on their weights

Property Documentation

FloatRegion CrossBase
getset

Shifts the Cross origin for this group by a value in the defined range

int FirstRepeating
getset

First index of the RepeatingItems range

bool IgnoreModuleCrossBase
getset

If true, the Cross origin for this group will not take into consideration the Cross parameters of the BuildVolumeSpots class/>

int ItemCount
get
List<CGBoundsGroupItem> Items
get
bool KeepTogether
getset

When true, the group will only be placed when all items can be placed in the space left.

int LastRepeating
getset

Last index of the RepeatingItems range

string Name
getset
bool RandomizeItems
getset

When enabled, items in groups will be selected randomly.

See also
RepeatingItems

bool RelativeTranslation
getset

When true, the translation of an item is done in the relative frame defined by the tangent and orientation (up vector) of the volume at the item's position

IntRegion RepeatingItems
getset

When

See also
RandomizeItems

is set to true, the randomized items are the the ones that have their indices inside the RepeatingItems range

RotationModeEnum RotationMode
getset

How the rotation axes are defined related to the Volume's data

FloatRegion RotationX
getset
FloatRegion RotationY
getset
FloatRegion RotationZ
getset
FloatRegion ScaleX
getset
FloatRegion ScaleY
getset
FloatRegion ScaleZ
getset
FloatRegion SpaceAfter
getset
FloatRegion SpaceBefore
getset
FloatRegion TranslationX
getset
FloatRegion TranslationY
getset
FloatRegion TranslationZ
getset
bool UniformScaling
getset

When true, the scaling vector is (ScaleX, ScaleX, ScaleX) instead of (ScaleX, ScaleY, ScaleZ)


The documentation for this class was generated from the following file: