Algo
Python API types
Read time 9 minutesLast updated 8 months ago
AlignmentMode
Enum of core.Int
Name | Value |
|---|---|
| Auto | 0 |
| Portrait | 1 |
| Landscape | 2 |
Functions accepting this type or a list of this type as a parameter:
AttributeType
Enum of core.Int
Name | Value |
|---|---|
| Patches | 4020 |
| PatchMaterials | 4021 |
| PatchBoundaries | 4022 |
| UVs | 4035 |
| Normals | 4036 |
| Tangents | 4037 |
| Binormals | 4038 |
Functions accepting this type or a list of this type as a parameter:
BakeMaps
Fields
Type | Name | Default | Description |
|---|---|---|---|
| diffuse | Boolean | True | |
| normal | Boolean | True | |
| roughness | Boolean | True | |
| metallic | Boolean | True | |
| opacity | Boolean | True | |
| ambientOcclusion | Boolean | True | |
| emissive | Boolean | True |
BakeOption
Fields
Type | Name | Default | Description |
|---|---|---|---|
| resolution | Int | 1024 | |
| padding | Int | 1 | Add padding to the map. A negative value means that the texture will be filled, and the padding for uv island is the absolute value. |
| textures | BakeMaps |
Functions accepting this type or a list of this type as a parameter:
BakedValue
Fields
Type | Name | Default | Description |
|---|---|---|---|
| occurrence | Occurrence | 0 | |
| polygonId | Ident | -1 | |
| paramU | Double | 0.0 | |
| paramV | Double | 0.0 | |
| material | Material | 0 |
BakingSession
Base class: core.UInt
Functions accepting this type or a list of this type as a parameter:
- algo.bakeAOMap
- algo.bakeDepthMap
- algo.bakeDiffuseMap
- algo.bakeDisplacementMap
- algo.bakeEmissiveMap
- algo.bakeFeatureMap
- algo.bakeMaterialAOMap
- algo.bakeMaterialIdMap
- algo.bakeMaterialPropertyMap
- algo.bakeMetallicMap
- algo.bakeNormalMap
- algo.bakeOccurrencePropertyMap
- algo.bakeOpacityMap
- algo.bakePartIdMap
- algo.bakePositionMap
- algo.bakeRoughnessMap
- algo.bakeSpecularMap
- algo.bakeUVMap
- algo.bakeValidityMap
- algo.bakeVertexColorMap
- algo.endBakingSession
- algo.fetchBakedMap
- algo.fetchBakedVertex
- algo.setBakingSessionPadding
- algo.fetchBakedMap
- algo.fetchBakedVertex
- algo.automaticUVMapping
- algo.getUVQualityMetrics
- algo.hasOverlappingUV
- algo.repackUV
- core.getRedoStepUserData
- core.getUndoStepUserData
- core.redo
- core.undo
- scene.getSubpartMaterial
- scene.setSubpartMaterial
- scene.setSubpartMaterials
- scene.setLocalMatrices
- view.getCameraFrontAxis
- view.getCameraPosition
- view.getCameraRightAxis
- view.getCameraUpAxis
Box
Fields
Type | Name | Default | Description |
|---|---|---|---|
| position | Affine | ||
| length | Double | 200 | |
| height | Double | 200 | |
| depth | Double | 200 |
Functions accepting this type or a list of this type as a parameter:
BoxParameters
Fields
Type | Name | Default | Description |
|---|---|---|---|
| SizeX | Double | 1000 | |
| SizeY | Double | 1000 | |
| SizeZ | Double | 1000 | |
| Subdivision | Int | 1 |
BricksReturn
Fields
Type | Name | Default | Description |
|---|---|---|---|
| Root | Occurrence | 0 | |
| Bricks | BrickDefinitionList |
CapsuleParameters
Fields
Type | Name | Default | Description |
|---|---|---|---|
| Radius | Double | 250 | |
| Height | Double | 250 | |
| Latitude | Int | 16 | |
| Longitude | Int | 16 |
ComputingQuality
Enum of core.Int
Name | Value |
|---|---|
| High | 0 |
| Medium | 1 |
| Low | 2 |
ConeParameters
Fields
Type | Name | Default | Description |
|---|---|---|---|
| BottomRadius | Double | 250 | |
| Height | Double | 500 | |
| Sides | Int | 16 |
ConvexityFilter
Enum of core.Long
Name | Value |
|---|---|
| OnConvex | 0 |
| OnConcave | 1 |
| OnConvexAndConcave | 2 |
Functions accepting this type or a list of this type as a parameter:
CostEvaluation
Enum of core.Int
Name | Value |
|---|---|
| SumEvaluation | 0 |
| MaxEvaluation | 1 |
| AverageEvaluation | 2 |
Functions accepting this type or a list of this type as a parameter:
CreateOccluder
Enum of core.Int
Name | Value |
|---|---|
| Occludee | 0 |
| Occluder | 1 |
Functions accepting this type or a list of this type as a parameter:
Cylinder
Fields
Type | Name | Default | Description |
|---|---|---|---|
| position | Affine | ||
| radius | Double | 100 | |
| length | Double | 200 |
Functions accepting this type or a list of this type as a parameter:
CylinderParameters
Fields
Type | Name | Default | Description |
|---|---|---|---|
| Radius | Double | 250 | |
| Height | Double | 1000 | |
| Sides | Int | 16 |
DecimateOptionsSelector
Select between:
-
triangleCount: core.ULong
-
ratio: core.Percent Functions accepting this type or a list of this type as a parameter:
DiskSegmentationMethod
Enum of core.Int
Name | Value |
|---|---|
| Perimeter | 0 |
| GaussianCurvature | 1 |
ElementFilter
Enum of core.Int
Name | Value |
|---|---|
| Polygons | 0 |
| Points | 1 |
| Hybrid | 2 |
Functions accepting this type or a list of this type as a parameter:
- algo.beginBakingSession
- algo.beginVertexBakingSession
- algo.marchingCubes
- algo.proxyMesh
- algo.voxelize
Feature
Fields
Type | Name | Default | Description |
|---|---|---|---|
| type | FeatureType | Unknown | |
| inputs | FeatureInputList |
FeatureInput
Fields
Type | Name | Default | Description |
|---|---|---|---|
| position | Point3 | ||
| direction | Vector3 | ||
| diameter | Distance | 0 |
FeatureInputList
List of algo.FeatureInput
FeatureList
List of algo.Feature
FeatureType
Enum of core.Int
Name | Value |
|---|---|
| Unknown | 0 |
| ThroughHole | 1 |
| BlindHole | 2 |
FilletingMode
Enum of core.Int
Name | Value |
|---|---|
| Width | 0 |
| Distance | 1 |
| Depth | 2 |
| Radius | 3 |
Functions accepting this type or a list of this type as a parameter:
FlatteningStopCondition
Enum of core.Long
Name | Value |
|---|---|
| MEAN_DEFORMATION | 0 |
| ABSOLUTE_DEFORMATION | 1 |
HexahedronParameters
Fields
Type | Name | Default | Description |
|---|---|---|---|
| XLength | Double | 1 | |
| YLength | Double | 1 | |
| ZLength | Double | 1 |
InnerOuterOption
Enum of core.Int
Name | Value |
|---|---|
| All | 0 |
| OnlyOuter | 1 |
| OnlyInners | 2 |
Functions accepting this type or a list of this type as a parameter:
- algo.createVisibilityInformationAdvanced
- algo.findOccludedPartOccurrencesAdvanced
- algo.removeOccludedGeometriesAdvanced
- algo.createCavityOccurrences
- algo.orientPolygonFacesAdvanced
MeshBooleanOperation
Enum of core.Int
Name | Value |
|---|---|
| SplitOnly | 0 |
| Union | 1 |
| Intersection | 2 |
| Subtraction | 3 |
Functions accepting this type or a list of this type as a parameter:
OccurrenceFeatures
Fields
Type | Name | Default | Description |
|---|---|---|---|
| occurrence | Occurrence | 0 | |
| features | FeatureList |
OccurrenceFeaturesList
List of algo.OccurrenceFeatures
OctahedralImpostor
Fields
Type | Name | Default | Description |
|---|---|---|---|
| OctaTransform | Matrix4 | geom.IdentityMatrix4 | |
| Radius | Double | 1 | |
| NormalMap | Image | 0 | |
| DepthMap | Image | 0 | |
| DiffuseMap | Image | 0 | |
| MetallicMap | Image | 0 | |
| AOMap | Image | 0 | |
| RoughnessMap | Image | 0 |
OrientStrategy
Enum of core.Int
Name | Value |
|---|---|
| ExteriorOnly | 0 |
| VisibilityOrExterior | 1 |
| VisibilityByConnected | 2 |
| VisibilityByPolygon | 3 |
| ConformToMajority | 4 |
Functions accepting this type or a list of this type as a parameter:
OrientStrategyAdvanced
Enum of core.Int
Name | Value |
|---|---|
| VisibilityByConnected | 0 |
| VisibilityByPolygon | 1 |
Functions accepting this type or a list of this type as a parameter:
Plane
Fields
Type | Name | Default | Description |
|---|---|---|---|
| position | Affine | ||
| length | Double | 200 | |
| height | Double | 200 |
Functions accepting this type or a list of this type as a parameter:
PlaneParameters
Fields
Type | Name | Default | Description |
|---|---|---|---|
| SizeX | Double | 1000 | |
| SizeY | Double | 1000 | |
| SubdivisionX | Int | 1 | |
| SubdivisionY | Int | 1 |
PrimitiveShapeParameters
Select between:
-
Box: algo.BoxParameters
-
Plane: algo.PlaneParameters
-
Sphere: algo.SphereParameters
-
Cylinder: algo.CylinderParameters
-
Cone: algo.ConeParameters
-
Capsule: algo.CapsuleParameters Functions accepting this type or a list of this type as a parameter:
QualityMemoryTradeoff
Enum of core.Int
Name | Value |
|---|---|
| PreferQuality | 0 |
| PreferMemory | 1 |
QualitySpeedTradeoff
Enum of core.Int
Name | Value |
|---|---|
| PreferQuality | 0 |
| PreferSpeed | 1 |
Functions accepting this type or a list of this type as a parameter:
RatioUV3DMode
Enum of core.Int
Name | Value |
|---|---|
| SmallestRatio | 0 |
| HighestRatio | 1 |
| AverageRatio | 2 |
| MedianRatio | 3 |
Functions accepting this type or a list of this type as a parameter:
RelaxUVMethod
Enum of core.Int
Name | Value |
|---|---|
| Angle | 0 |
| Edge | 1 |
ReplaceByBoxType
Enum of core.Int
Name | Value |
|---|---|
| Minimum | 0 |
| LocallyAligned | 1 |
Functions accepting this type or a list of this type as a parameter:
ReplaceByMode
Enum of core.Int
Name | Value |
|---|---|
| ByOccurrence | 0 |
| All | 1 |
ReplaceByOccurrenceOptions
Fields
Type | Name | Default | Description |
|---|---|---|---|
| Occurrence | Occurrence | 0 | |
| Aligned | Boolean | False |
ReplaceByOption
Select between:
-
Occurrence: algo.ReplaceByOccurrenceOptions
-
BoundingBox: algo.ReplaceByBoxType
-
ConvexHull: core.None
-
Primitive: algo.ReplaceByPrimitiveOptions Functions accepting this type or a list of this type as a parameter:
ReplaceByPrimitiveOptions
Fields
Type | Name | Default | Description |
|---|---|---|---|
| Type | PrimitiveShapeParameters | ||
| Aligned | Boolean | False | |
| GenerateUV | Boolean | True |
SawingMode
Enum of core.Int
Name | Value |
|---|---|
| SawOnly | 0 |
| SawAndSplit | 1 |
| KeepInside | 2 |
| KeepOutside | 3 |
Functions accepting this type or a list of this type as a parameter:
SelectionLevel
Enum of core.Int
Name | Value |
|---|---|
| Parts | 0 |
| Patches | 1 |
| Polygons | 2 |
Functions accepting this type or a list of this type as a parameter:
- algo.createVisibilityInformation
- algo.createVisibilityInformationAdvanced
- algo.removeOccludedGeometries
- algo.removeOccludedGeometriesAdvanced
- algo.removeOccludedGeometriesFromPoints
- algo.removeOccludedGeometriesFromViewPoints
Space
Enum of core.Int
Name | Value |
|---|---|
| Object | 0 |
| World | 1 |
| Tangent | 2 |
Functions accepting this type or a list of this type as a parameter:
Sphere
Fields
Type | Name | Default | Description |
|---|---|---|---|
| position | Affine | ||
| radius | Double | 100 |
Functions accepting this type or a list of this type as a parameter:
SphereParameters
Fields
Type | Name | Default | Description |
|---|---|---|---|
| Radius | Double | 500 | |
| Latitude | Int | 16 | |
| Longitude | Int | 16 |
TransformationType
Enum of core.Int
Name | Value |
|---|---|
| TRSOnly | 0 |
| TRSAndSkew | 1 |
Functions accepting this type or a list of this type as a parameter:
UVGenerationMode
Enum of core.Int
Name | Value |
|---|---|
| NoUV | 0 |
| IntrinsicUV | 1 |
| ConformalScaledUV | 2 |
Functions accepting this type or a list of this type as a parameter:
UVImportanceEnum
Enum of core.Int
Name | Value |
|---|---|
| PreserveSeamsAndReduceDeformation | 0 |
| PreserveSeams | 1 |
| IgnoreUV | 2 |
Functions accepting this type or a list of this type as a parameter:
UnwrapUVMethod
Enum of core.Int
Name | Value |
|---|---|
| Isometric | 0 |
| Conformal | 1 |
Functions accepting this type or a list of this type as a parameter:
UseColorOption
Select between:
-
UseLinesColor: core.None
-
ChooseColor: core.Color Functions accepting this type or a list of this type as a parameter:
VertexWeightStrategy
Enum of core.Int
Name | Value |
|---|---|
| RedBlueDiff | 0 |
| Grayscale | 1 |
| InvertedGrayscale | 2 |
Functions accepting this type or a list of this type as a parameter:
VisibilityToWeightMode
Enum
Name | Value |
|---|---|
| FrontCountOnly | 0 |
| FrontAndBackCount | 1 |
| FrontCountOnlyAreaWeighted | 2 |
| FrontAndBackCountAreaWeighted | 3 |
Functions accepting this type or a list of this type as a parameter:
getPixelValue
getPixelValueList
List of algo.getPixelValue