Class: CreateInfo

algeobra~CreateInfo(name, dependencies, params, ignoreInvalids)

Container for information used in object definitions

Constructor

new CreateInfo(name, dependencies, params, ignoreInvalids)

Parameters:

Name	Type	Default	Description
`name`	String		The name of the create struct. Only needs to be unique per definition type
`dependencies`	Array \| Object		The objects the definition depends on. Might be an array or an object as a table (only key->val pairs) The keys of the dependencies will be replicated for consumption in definitions. When creating the definitions, the values should be the indices gained from the GeometryScene object or EMPTY, if the specific dependency is optional. Definitions will receve a CreateInfo like object containing the same keys as the one specified at the beginning, but filled with the requested dependencies. One may also fill a CreateInfo with values instead of index handles themselves and pass them to the compute method of a definition
`params`	Array \| Object		Any parameters that are not dependant on the scene, but instead provide additional information for a specific construction method
`ignoreInvalids`	Boolean	false	Specifies, whether INVALID values are ignored, when gathering dependencies. Generally, a definition can only be valid, if its dependencies are valid. Sometimes, it might be useful to use INVALID inputs anyways. For example, when gathering the results of multiple intersections, which might not all be defined. This way, INVALID parts can just be filtered out

Source:

algeobra.js, line 818

Methods

(static) new(name, dependencies, params, ignoreInvalids)

Create a new CreatInfo instance

Parameters:

Name	Type	Default	Description
`name`	String		The name of the create struct. Only needs to be unique per definition type
`dependencies`	Array \| Object		The objects the definition depends on. Might be an array or an object as a table (only key->val pairs) The keys of the dependencies will be replicated for consumption in definitions. When creating the definitions, the values should be the indices gained from the GeometryScene object or EMPTY, if the specific dependency is optional. Definitions will receve a CreateInfo like object containing the same keys as the one specified at the beginning, but filled with the requested dependencies. One may also fill a CreateInfo with values instead of index handles themselves and pass them to the compute method of a definition
`params`	Array \| Object		Any parameters that are not dependant on the scene, but instead provide additional information for a specific construction method
`ignoreInvalids`	Boolean	false	Specifies, whether INVALID values are ignored, when gathering dependencies. Generally, a definition can only be valid, if its dependencies are valid. Sometimes, it might be useful to use INVALID inputs anyways. For example, when gathering the results of multiple intersections, which might not all be defined. This way, INVALID parts can just be filtered out

Source:

algeobra.js, line 855

Returns:

A new CreateInfo instance