Aspose.3D FOSS for .NET

API reference for Aspose.3d FOSS for .NET v1.0.0. 292 public types organized by module.

Main

ClassDescription
A3DObjectThe base class of all Aspose.ThreeD objects, all sub classes will support dynamic properties.
A3dwSaveOptionsSave options for A3DW format.
AmfSaveOptionsSave options for AMF.
AnimationChannelAnimationChannel stores a sequence of keyframes and provides Add(time, value) to insert new keyframe data.
AnimationClipThe Animation clip is a collection of animations.
AnimationNodeAspose.3D’s supports animation hierarchy, each animation can be composed by several animations and animation’s key-frame definition.
ArbitraryProfileThis class allows you to construct a 2D profile directly from arbitrary curve.
AssetInfoInformation of asset.
AxisSystemAxis system is an combination of coordinate system, up vector and front vector.
BindPointA BindPoint is usually created on an object’s property, some property types contains multiple component fields(like a Vector3 field), will generate channel for each component field and connects the field to one or more keyframe sequence instance(s) through the channels.
BoneA bone defines the subset of the geometry’s control point, and defined blend weight for each control point.
BonePoseThe contains the transformation matrix for a bone node.
BooleanOperandThis class encapsulates the transformed mesh as Boolean operation’s operand.
BooleanOperatorClass with 9 methods and 9 properties.
BoxBox.
CShapeIFC compatible C-shape profile that defined by parameters.
CameraThe camera describes the eye point of the viewer looking at the scene.
CenterLineProfileIFC compatible center line profile.
CircleA curve consists of a set of points in the edge of the circle shape.
CircleShapeIFC compatible circle profile, which can be used to construct a mesh through.
ClassTypeThe class definitions .
ColladaSaveOptionsSave options for Collada format.
CompositeCurveA is consisting of several curve segments.
CurveThe base class of all curve implementations.
CustomObjectRepresents custom object data.
CylinderParameterized Cylinder.
DeformerBase class for and.
DescriptorSetUpdaterThis class allows to update the in a chain operation.
Discreet3dsLoadOptionsLoad options for 3DS file.
Discreet3dsSaveOptionsSave options for 3DS file.
DishParameterized dish.
DracoFormatGoogle Draco format.
DracoSaveOptionsSave options for Google draco files.
DriverExceptionThe exception raised by internal rendering drivers.
EllipseAn Ellipse defines a set of points that form the shape of ellipse.
EllipseShapeIFC compatible ellipse profile.
EntityThe base class of all entities.
EntityRendererSubclass this to implement rendering for different kind of entities.
EntityRendererKeyThe key of registered entity renderer.
EnumTypeClass with 3 methods and 2 properties.
EnumValueClass with 2 methods and 2 properties.
ExportExceptionExport exception.
ExtrapolationExtrapolation.Type gets or sets the extrapolation mode using the ExtrapolationType enum.
FbxLoadOptionsLoad options for FBX format.
FbxSaveOptionsSave options for FBX format.
FileFormatFile format definition.
FileFormatTypeFile format type.
FileSystemFile system encapsulation.
FontFileFont file contains definitions for glyphs, this is used to create text profile.
FrustumThe base class of Camera and Light.
GLSLSourceThe source code of shaders in GLSL.
GeometryThe base class of all renderable geometric objects (like Mesh, Box, Cylinder and etc.).
GlobalTransformGlobal transform is similar to but it’s immutable while it represents the final evaluated transformation.
GltfLoadOptionsLoad options for glTF format.
GltfSaveOptionsSave options for glTF format.
GroupA represents the logical relationships of .
HShapeThe provides the defining parameters of an ‘H’ or ‘I’ shape.
HalfSpacerepresents a infinity space which is split by a plane, this can be used with.
HollowCircleShapeIFC compatible hollow circle profile.
HollowRectangleShapeIFC compatible hollow rectangular shape with both inner/outer rounding corners.
Html5SaveOptionsSave options for HTML5.
IOConfigIO config for serialization/deserialization.
IOExtensionIOExtension.Write writes the Matrix4 value to the provided BinaryWriter.
ImageRenderOptionsOptions for and.
ImportExceptionImport exception.
InitializationExceptionInitialization exception.
JtLoadOptionsLoad options for Siemens JT.
KeyFrameKeyFrame.KeyFrame creates a new empty key frame instance.
KeyframeSequenceKeyframeSequence.KeyframeSequence creates an empty keyframe sequence with no property name.
LShapeIFC compatible L-shape profile that defined by parameters.
LambertMaterialMaterial for lambert shading model.
LicenseLicense management class (not available in FOSS version).
LightThe light illuminates the scene.
LineA polyline is a path defined by a set of points with segments, and connected by edges, which means it can also be a set of connected line segments.
LinearExtrusionLinear extrusion takes a 2D shape as input and extends the shape in the 3rd dimension.
LoadOptionsThe base class to configure options in file loading for different types.
MaterialMaterial defines the parameters necessary for visual appearance of geometry.
MathUtilsMathUtils.CalcNormal calculates the normal vector of a polygon defined by an array of Vector3 points.
MeshA mesh is made of many n-sided polygons.
MeteredMetered license management class (not available in FOSS version).
Microsoft3MFFormatFile format instance for Microsoft 3MF with 3MF related utilities.
Microsoft3MFSaveOptionsClass with 1 method and 9 properties.
MirroredProfileIFC compatible mirror profile.
MorphTargetChannelA MorphTargetChannel is used by to organize the target geometries.
MorphTargetDeformerMorphTargetDeformer provides per-vertex animation.
NodeRepresents an element in the scene graph.
NurbsCurveNURBS curve is a curve represented by NURBS(Non-uniform rational basis spline), A NURBS curve is defined by its control points, a set of weighted control points and a knot vector The w component in co.
NurbsDirectionA 3D surface has two direction, the U and V, the NurbsDirection defines data for each direction.
NurbsSurfaceis a surface represented by NURBS(Non-uniform rational basis spline), A is defined by two and .
ObjLoadOptionsLoad options for Wavefront OBJ format.
ObjSaveOptionsSave options for Wavefront OBJ format.
ParameterizedProfileThe base class of all parameterized profiles.
ParseExceptionParseException.ParseException creates a new ParseException with the provided error message.
PatchA is a parametric modeling surface, similar to , it’s also defined by two , the and .
PatchDirectionPatch’s U and V direction.
PbrMaterialMaterial for physically based rendering based on albedo color/metallic/roughness.
PbrSpecularMaterialMaterial for physically based rendering based on diffuse color/specular/glossiness.
PdfFormatAdobe’s Portable Document Format.
PdfLoadOptionsOptions for PDF loading.
PdfSaveOptionsThe save options in PDF exporting.
PhongMaterialMaterial for blinn-phong shading model.
PixelMappingClass with 1 method and 4 properties.
PlaneParameterized plane.
PlyFormatThe PLY format.
PlyLoadOptionsPlyLoadOptions.PlyLoadOptions creates a new instance with default options for loading PLY files.
PlySaveOptionsPlySaveOptions.PlySaveOptions constructs a new instance with default PLY save settings.
PointCloudThe point cloud contains no topology information but only the control points and the vertex elements.
PolygonBuilderA helper class to build polygon for.
PolygonModifierPolygonModifier.Triangulate triangulates all faces of the supplied Mesh into triangles.
PoseThe pose is used to store transformation matrix when the geometry is skinned.
PostProcessingThe post-processing effects.
PrimitiveBase class for all primitives.
Profile2D Profile in xy plane.
Property-GLTFProperty objects expose GetExtra and SetExtra methods for storing arbitrary user data, and GetBindPoint for retrieving animation bind points.
Property-ThreeDClass to hold user-defined properties.
PropertyCollectionThe collection of properties.
PropertyTableClass with 6 methods and 3 properties.
PushConstantA utility to provide data to shader through push constant.
PyramidParameterized pyramid.
RectangleShapeIFC compatible rectangular shape with rounding corners.
RectangularTorusParameterized rectangular torus.
RenderFactoryRenderFactory creates all resources that represented in rendering pipeline.
RenderParametersDescribe the parameters of the render target.
RenderResourceRender resource base class.
RenderStateRender state for building the pipeline The changes made on render state will not affect the created pipeline instances.
RendererThe context about renderer.
RendererVariableManagerThis class manages variables used in rendering.
RevolvedAreaSolidThis class represents a solid model by revolving a cross section provided by a profile about an axis.
RvmFormatThe RVM Format.
RvmLoadOptionsLoad options for AVEVA Plant Design Management System’s RVM file.
RvmSaveOptionsSave options for Aveva PDMS RVM file.
SPIRVSourceThe compiled shader in SPIR-V format.
SaveOptionsThe base class to configure options in file saving for different types.
SceneA scene is a top-level object that contains the nodes, geometries, materials, textures, animation, poses, sub-scenes and etc.
SceneObjectThe root class of objects that will be stored inside a scene.
SegmentA segment in composite curve.
SemanticAttributeSemanticAttribute.SemanticAttribute creates a new attribute with the specified vertex field semantic.
ShaderExceptionShader related exceptions.
ShaderMaterialA shader material allows to describe the material by external rendering engine or shader language.
ShaderProgramThe shader program.
ShaderSetShader programs for each kind of materials.
ShaderSourceThe source code of shader.
ShaderTechniqueA shader technique represents a concrete rendering implementation.
ShaderVariableShader variable.
ShapeThe shape describes the deformation on a set of control points, which is similar to the cluster deformer in Maya.
SkeletonThe Skeleton is mainly used by CAD software to help designer to manipulate the transformation of skeletal structure, it’s usually useless outside the CAD softwares.
SkinDeformerA skin deformer contains multiple bones to work, each bone blends a part of the geometry by control point’s weights.
SphereParameterized sphere.
StencilStateStencil states per face.
StlLoadOptionsLoad options for STL format.
StlSaveOptionsSave options for STL format.
StructuralMetadataThis class provides support for EXT_structural_metadata, only used in glTF.
SweptAreaSolidA SweptAreaSolid constructs a geometry by sweeping a profile along a directrix.
TShapeIFC compatible T-shape defined by parameters.
TextText profile, this profile describes contours using font and text.
TextureThis class defines the texture from an external file.
TextureBaseBase class for all concrete textures.
TextureCodecClass to manage encoders and decoders for textures.
TextureDataThis class contains the raw data and format definition of a texture.
TextureSlotTexture slot in Material, can be enumerated through material instance.
TorusParameterized torus.
TransformA transform contains information that allow access to object’s translate/scale/rotation or transform matrix at minimum cost This is used by local transform.
TransformBuilderTransformBuilder enables composition of multiple transform matrices with methods like Append, Prepend, Scale, RotateDegree, and provides the resulting Matrix via its Matrix property.
TransformedCurveA TransformedCurve gives a curve a placement by using a transformation matrix.
TrapeziumShapeIFC compatible Trapezium shape defined by parameters.
TriMeshA TriMesh contains raw data that can be used by GPU directly.
TrialExceptionTrial exception.
TrimmedCurveA bounded curve that trimmed the basis curve at both ends.
U3dLoadOptionsLoad options for universal 3d.
U3dSaveOptionsSave options for universal 3d.
UShapeIFC compatible U-shape defined by parameters.
UsdSaveOptionsSave options for USD/USDZ formats.
VertexVertex.ReadVector3(field) reads a 3‑component vector from the specified vertex field, enabling extraction of position data.
VertexDeclarationVertexDeclaration lets you define custom vertex layouts by calling AddField(dataType, semantic, index, alias); once sealed, the layout cannot be changed.
VertexElementBase class of vertex elements.
VertexElementBinormalVertexElementBinormal.VertexElementBinormal() creates a new instance with default mapping and reference modes.
VertexElementDoublesTemplateA helper class for defining concrete implementations.
VertexElementEdgeCreaseDefines the edge crease for specified components.
VertexElementFVectorA helper class for defining concrete implementations.
VertexElementHoleDefines if specified polygon is hole.
VertexElementIntsTemplateA helper class for defining concrete implementations.
VertexElementMaterialDefines material index for specified components.
VertexElementNormalVertexElementNormal.VertexElementNormal(mappingMode, referenceMode) creates a new VertexElementNormal using the given mapping and reference modes.
VertexElementPolygonGroupDefines polygon group for specified components to group related polygons together.
VertexElementSmoothingGroupA smoothing group is a group of polygons in a polygon mesh which should appear to form a smooth surface.
VertexElementSpecularDefines specular color for specified components.
VertexElementTangentVertexElementTangent.Tangents provides a list of Vector4 objects representing per‑vertex tangent data.
VertexElementTemplateA helper class for defining concrete implementations.
VertexElementUVDefines the UV coordinates for specified components.
VertexElementUserDataDefines custom user data for specified components.
VertexElementVector4A helper class for defining concrete implementations.
VertexElementVertexColorDefines the vertex color for specified components.
VertexElementVertexCreaseDefines the vertex crease for specified components.
VertexElementVisibilityDefines if specified components is visible.
VertexElementWeightDefines blend weight for specified components.
VertexFieldVertexField objects expose DataType, Semantic, Alias, Index, Offset, and Size properties, enabling detailed description of custom vertex attributes.
ViewportA contains at least one viewport for rendering the scene.
WatermarkWatermark utilities let developers embed and extract text watermarks in 3D files, with optional password protection and a permanent flag.
WindowHandleEncapsulated window handle for different platforms.
XLoadOptionsThe Load options for DirectX X files.
ZShapeIFC compatible Z-shape profile that defined by parameters.

Interfaces

InterfaceDescription
IArrayListAspose.3D has its own highly optimized implementation of List{T} for better loading/saving performance Only this interface is exposed for user with IList{T} compatible and similar interfaces.
IBufferThe base interface of all managed buffers used in rendering.
ICommandListEncodes a sequence of commands which will be sent to GPU to render.
IDescriptorSetThe descriptor sets describes different resources that can be used to bind to the render pipeline like buffers, textures.
IIndexBufferThe index buffer describes the geometry used in rendering pipeline.
IIndexedVertexElementVertexElement with indices data.
IMeshConvertibleEntities that implemented this interface can be converted to mesh.
INamedObjectObject that has a name.
IOrientableOrientable entities shall implement this interface.
IPipelinePipeline interface.
IRenderQueueEntity renderer uses this queue to manage render tasks.
IRenderTargetThe base interface of render target.
IRenderTextureThe interface of render texture.
IRenderWindowRender window interface.
ITexture1D1D texture.
ITexture2D2D texture.
ITextureCodecCodec for textures.
ITextureCubemapCube map texture.
ITextureDecoderExternal texture decoder should implement this interface for decoding.
ITextureEncoderExternal texture encoder should implement this interface for encoding.
ITextureUnitrepresents a texture in the memory that shared between GPU and CPU and can be sampled by the shader, where the only represents a reference to an external file.
IVertexBufferThe vertex buffer holds the polygon vertex data that will be sent to rendering pipeline.

Structs

StructDescription
BoundingBoxThe axis-aligned bounding box.
BoundingBox2DBoundingBox2D.BoundingBox2D initializes a new 2‑D bounding box with the specified minimum and maximum vectors.
CubeFaceDataData for each face of the cube map texture.
EndPointThe end point to trim the curve, can be a parameter value or a Cartesian point.
FMatrix4FMatrix4.Identity provides a static identity matrix; Concatenate, Transpose, and Inverse enable matrix composition and transformation operations.
FVector2FVector2.FVector2 creates a 2‑D vector with the given x and y float components.
FVector3Represents a 3D vector.
FVector4FVector4.FVector4(x:float, y:float, z:float, w:float) creates a 4‑D vector with given x, y, z, w values.
Matrix4Matrix4 offers constructors for row‑vector and element‑wise initialization and provides methods such as Inverse() and Decompose() for advanced matrix manipulation.
QuaternionQuaternion is usually used to perform rotation in computer graphics.
RectRect represents a rectangle with position and size, offering a Contains method to test whether a point lies inside it.
RelativeRectangleRelativeRectangle.RelativeRectangle creates a rectangle with given left, top, width, height offsets.
Vector2Vector2.Vector2 creates a vector with both components set to the given scalar.
Vector3The Vector3 class supplies full 3‑D vector mathematics, including dot product, cross product, normalization, and angle calculations between directions.
Vector4Vector4.Vector4 creates a vector from a Vector3 and a double w component.

Enumerations

EnumerationDescription
AlphaSourceDefines whether the texture contains the alpha channel.
ApertureModeCamera aperture modes.
AxisAxis.
BlendFactorBlend factor specify pixel arithmetic.
BoneLinkModeA bone’s link mode refers to the way in which a bone is connected or linked to its parent bone within a hierarchical structure.
BooleanOperationMesh’s Boolean operation.
BoundingBoxExtentThe extent of the bounding box.
ColladaTransformStyleThe node’s transformation style of node.
CompareFunctionCompare function for depth/stencil testing.
ComposeOrderThe order to compose transform matrix.
CoordinateSystemCoordinate system.
CubeFaceCube face selection.
CullFaceModeCull face mode.
CurveDimensionThe dimension of the curves.
DracoCompressionLevelCompression level for draco file.
DrawOperationThe primitive types to render.
EntityRendererFeaturesThe extra features that the entity renderer will provide.
ExtrapolationTypeExtrapolation type.
FileContentTypeFile content type.
FrontFaceFront face winding.
GltfEmbeddedImageFormatHow glTF exporter will embed the textures during the exporting.
IndexDataTypeThe data type of the elements in.
InterpolationThe key frame’s interpolation type.
LightTypeLight types.
MappingModeMapping mode.
NurbsTypeNURBS types.
PatchDirectionTypePatch direction’s types.
PdfLightingSchemeLightingScheme specifies the lighting to apply to 3D artwork.
PdfRenderModeRender mode specifies the style in which the 3D artwork is rendered.
PixelFormatThe pixel’s format used in texture unit.
PixelMapModeEnum with 3 members.
PolygonModePolygon mode.
PoseTypePose type.
PresetShadersThis defines the preset internal shaders used by the renderer.
ProjectionTypeCamera’s projection types.
PropertyFlagsProperty’s flags.
ReferenceModedefines how mapping information is stored and referenced by.
RenderQueueGroupIdThe group id of render queue.
RenderStageThe render stage.
RotationModeThe frustum’s rotation mode.
RotationOrderThe order controls which rx ry rz are applied in the transformation matrix.
ShaderStageShader stage.
SkeletonTypeEnum with 2 members.
SplitMeshPolicyShare vertex/control point data between sub-meshes or each sub-mesh has its own compacted data.
StencilActionStencil action.
StepModeInterpolation step mode.
TextureFilterFilter options during texture sampling.
TextureMappingThe texture mapping type for Describes which kind of texture mapping is used.
TextureTypeThe type of the.
VertexElementTypeThe type of the vertex element, defined how it will be used in modeling.
VertexFieldDataTypeVertex field’s data type.
VertexFieldSemanticThe semantic of the vertex field.
WeightedModeWeighted mode.
WrapModeTexture’s wrap mode.

See Also

 English