API Reference

• metafold package
  • Submodules
  • Module contents
    • MetafoldClient
      • MetafoldClient.projects
      • MetafoldClient.assets
      • MetafoldClient.jobs
  • metafold.projects module
    • Access
      • Access.PRIVATE
      • Access.PUBLIC
    • Project
      • Project.id
      • Project.user
      • Project.name
      • Project.access
      • Project.created
      • Project.modified
      • Project.thumbnail
      • Project.project
      • Project.graph
    • ProjectsEndpoint
      • ProjectsEndpoint.create()
      • ProjectsEndpoint.delete()
      • ProjectsEndpoint.duplicate()
      • ProjectsEndpoint.get()
      • ProjectsEndpoint.list()
      • ProjectsEndpoint.update()
  • metafold.assets module
    • Asset
      • Asset.id
      • Asset.filename
      • Asset.size
      • Asset.checksum
      • Asset.created
      • Asset.modified
      • Asset.project_id
      • Asset.job_id
    • AssetsEndpoint
      • AssetsEndpoint.create()
      • AssetsEndpoint.delete()
      • AssetsEndpoint.download_file()
      • AssetsEndpoint.get()
      • AssetsEndpoint.list()
  • metafold.jobs module
    • IO
      • IO.params
      • IO.assets
    • IODict
    • Job
      • Job.id
      • Job.name
      • Job.type
      • Job.state
      • Job.created
      • Job.started
      • Job.finished
      • Job.error
      • Job.inputs
      • Job.outputs
      • Job.needs
      • Job.project_id
      • Job.workflow_id
      • Job.assets
      • Job.parameters
      • Job.meta
    • JobsEndpoint
      • JobsEndpoint.delete()
      • JobsEndpoint.get()
      • JobsEndpoint.list()
      • JobsEndpoint.run()
      • JobsEndpoint.run_status()
      • JobsEndpoint.update()
  • metafold.workflows module
    • Workflow
      • Workflow.id
      • Workflow.state
      • Workflow.created
      • Workflow.started
      • Workflow.finished
      • Workflow.definition
      • Workflow.project_id
      • Workflow.get_asset()
      • Workflow.get_parameter()
    • WorkflowsEndpoint
      • WorkflowsEndpoint.cancel()
      • WorkflowsEndpoint.delete()
      • WorkflowsEndpoint.get()
      • WorkflowsEndpoint.list()
      • WorkflowsEndpoint.run()
  • metafold.client module
    • Client
      • Client.poll()
  • metafold.func module
    • BoxFramePrimitive()
    • BoxPrimitive()
    • CSG
    • CSGIntersect()
    • CSGSubtract()
    • CSGUnion()
    • CSG_Parameters
      • CSG_Parameters.operation
      • CSG_Parameters.smoothing
    • CappedConePrimitive()
    • CapsulePrimitive()
    • ComputeCurvatures
    • ComputeCurvatures_Parameters
      • ComputeCurvatures_Parameters.spacing_type
      • ComputeCurvatures_Parameters.step_size
      • ComputeCurvatures_Parameters.volume_size
    • ComputeNormals
    • ComputeNormals_Parameters
      • ComputeNormals_Parameters.spacing_type
      • ComputeNormals_Parameters.step_size
      • ComputeNormals_Parameters.volume_size
    • CylinderPrimitive()
    • EllipsoidPrimitive()
    • GenerateSamplePoints
    • GenerateSamplePoints_Parameters
      • GenerateSamplePoints_Parameters.offset
      • GenerateSamplePoints_Parameters.resolution
      • GenerateSamplePoints_Parameters.size
      • GenerateSamplePoints_Parameters.xform
    • GradeCellSize
    • GradeCellSize_Parameters
      • GradeCellSize_Parameters.num_steps
      • GradeCellSize_Parameters.offset
      • GradeCellSize_Parameters.shape_size
      • GradeCellSize_Parameters.shape_type
      • GradeCellSize_Parameters.shape_xform
      • GradeCellSize_Parameters.step_size
      • GradeCellSize_Parameters.width
      • GradeCellSize_Parameters.xform
    • InterpolateBoundaryCoords
    • InterpolateBoundaryCoords_Parameters
      • InterpolateBoundaryCoords_Parameters.tolerance
      • InterpolateBoundaryCoords_Parameters.xform
    • LinearFilter
    • LinearFilter_Parameters
      • LinearFilter_Parameters.scale_a
      • LinearFilter_Parameters.scale_b
    • LinkPrimitive()
    • LoadSamplePoints
    • LoadSamplePoints_Parameters
      • LoadSamplePoints_Parameters.points
    • LoadVolume
    • LoadVolume_Parameters
      • LoadVolume_Parameters.component_type
      • LoadVolume_Parameters.resolution
    • MapTexturePrimitive
    • MapTexturePrimitive_Parameters
      • MapTexturePrimitive_Parameters.box_width
      • MapTexturePrimitive_Parameters.scale
      • MapTexturePrimitive_Parameters.shape_type
      • MapTexturePrimitive_Parameters.shape_xform
      • MapTexturePrimitive_Parameters.xform
    • PlanePrimitive()
    • PointSource()
    • Redistance
    • Redistance_Parameters
      • Redistance_Parameters.post_offset
      • Redistance_Parameters.pre_offset
    • SampleBeam
    • SampleBeam_Parameters
      • SampleBeam_Parameters.node_radius
      • SampleBeam_Parameters.node_type
      • SampleBeam_Parameters.section_radius
      • SampleBeam_Parameters.section_type
      • SampleBeam_Parameters.smoothing
      • SampleBeam_Parameters.xform
    • SampleBox
    • SampleBox_Parameters
      • SampleBox_Parameters.free_param
      • SampleBox_Parameters.shape_type
      • SampleBox_Parameters.size
      • SampleBox_Parameters.xform
    • SampleCustomShape
    • SampleCustomShape_Parameters
      • SampleCustomShape_Parameters.xform
    • SampleLattice
    • SampleLattice_Parameters
      • SampleLattice_Parameters.lattice_data
      • SampleLattice_Parameters.node_radius
      • SampleLattice_Parameters.node_type
      • SampleLattice_Parameters.scale
      • SampleLattice_Parameters.scale_grading_range
      • SampleLattice_Parameters.scale_grading_scale
      • SampleLattice_Parameters.section_radius
      • SampleLattice_Parameters.section_radius_grading_range
      • SampleLattice_Parameters.section_radius_grading_scale
      • SampleLattice_Parameters.section_type
      • SampleLattice_Parameters.smoothing
      • SampleLattice_Parameters.xform
    • SampleSpinodoid
    • SampleSpinodoid_Parameters
      • SampleSpinodoid_Parameters.angles
      • SampleSpinodoid_Parameters.density
      • SampleSpinodoid_Parameters.pore_size
      • SampleSpinodoid_Parameters.wave_count
      • SampleSpinodoid_Parameters.xform
    • SampleSurfaceLattice
    • SampleSurfaceLattice_Parameters
      • SampleSurfaceLattice_Parameters.lattice_type
      • SampleSurfaceLattice_Parameters.scale
      • SampleSurfaceLattice_Parameters.scale_grading_range
      • SampleSurfaceLattice_Parameters.scale_grading_scale
      • SampleSurfaceLattice_Parameters.threshold
      • SampleSurfaceLattice_Parameters.threshold_grading_offset
      • SampleSurfaceLattice_Parameters.threshold_grading_range
      • SampleSurfaceLattice_Parameters.xform
    • SampleTriangleMesh
    • SampleTriangleMeshBvh
    • SampleTriangleMeshBvh_Parameters
      • SampleTriangleMeshBvh_Parameters.cw_winding
      • SampleTriangleMeshBvh_Parameters.xform
    • SampleTriangleMesh_Parameters
      • SampleTriangleMesh_Parameters.cw_winding
      • SampleTriangleMesh_Parameters.xform
    • SampleVolume
    • SampleVolume_Parameters
      • SampleVolume_Parameters.volume_offset
      • SampleVolume_Parameters.volume_size
      • SampleVolume_Parameters.xform
    • Shell
    • Shell_Parameters
      • Shell_Parameters.offset
      • Shell_Parameters.thickness
    • Threshold
    • Threshold_Parameters
      • Threshold_Parameters.width
    • TorusPrimitive()
    • TransformCylindricalCoords
    • TransformCylindricalCoords_Parameters
      • TransformCylindricalCoords_Parameters.radial_scale
      • TransformCylindricalCoords_Parameters.xform
    • TransformMirrorCoords
    • TransformMirrorCoords_Parameters
      • TransformMirrorCoords_Parameters.mirror_normal
      • TransformMirrorCoords_Parameters.mirror_point
      • TransformMirrorCoords_Parameters.xform
    • TransformSphericalCoords
    • TransformSphericalCoords_Parameters
      • TransformSphericalCoords_Parameters.xform
    • TransformTwistCoords
    • TransformTwistCoords_Parameters
      • TransformTwistCoords_Parameters.axis
      • TransformTwistCoords_Parameters.frequency
      • TransformTwistCoords_Parameters.xform
  • metafold.exceptions module
    • PollTimeout