Package com.aspose.threed

Interface Summary

Interface	Description
Enumerable<T>
Enumerator<T>	Generic enumerator for collection of type T
EventCallback<EventArg>	Created by lexchou on 4/24/2017.
FileSystemFactory	SaveOptions and LoadOptions will create a LocalFileSystem for default.
IIndexedVertexElement	VertexElement with indices data.
IMeshConvertible	Entities that implemented this interface can be converted to Mesh
INamedObject	Object that has a name
IOrientable	Orientable entities shall implement this interface.
ITextureCodec	Codec for textures
ITextureDecoder	External texture decoder should implement this interface for decoding.
ITextureEncoder	External texture encoder should implement this interface for encoding.
MaterialConverter	Custom converter to convert the geometry's original material to GLTF's PBR material.
NodeVisitor	A callback to travel through the whole node hierarchy.
Struct<T>	Created by lexchou on 11/13/2017.

Class Summary

Class	Description
A3DObject	The base class of all Aspose.ThreeD objects, all sub classes will support dynamic properties.
A3dwSaveOptions	Save options for A3DW format.
AmfSaveOptions	Save options for AMF
AnimationChannel	A channel maps property's component field to a set of keyframe sequences
AnimationClip	The Animation clip is a collection of animations.
AnimationNode	Aspose.3D's supports animation hierarchy, each animation can be composed by several animations and animation's key-frame definition.
ArbitraryProfile	This class allows you to construct a 2D profile directly from arbitrary curve.
AssetInfo	Information of asset.
AxisSystem	Axis system is an combination of coordinate system, up vector and front vector.
BindPoint	A BindPoint is usually created on an object's property, some property types contains multiple component fields(like a Vector3 field), BindPoint will generate channel for each component field and connects the field to one or more keyframe sequence instance(s) through the channels.
Bone	A bone defines the subset of the geometry's control point, and defined blend weight for each control point.
BonePose	The BonePose contains the transformation matrix for a bone node
BooleanOperand	This class encapsulates the transformed mesh as Boolean operation's operand.
BooleanOperator	Boolean operator allows you to apply Boolean operation on two IMeshConvertible instances.
BoundingBox	The axis-aligned bounding box Example: The following code shows how to get a bounding box from an Entity instance.
BoundingBox2D	The axis-aligned bounding box for Vector2
Box	Box.
Camera	The camera describes the eye point of the viewer looking at the scene.
Cancellation	This class allows you to manually abort a load/save task.
CenterLineProfile	IFC compatible center line profile
Circle	A Circle curve consists of a set of points in the edge of the circle shape.
CircleShape	IFC compatible circle profile, which can be used to construct a mesh through LinearExtrusion
ColladaSaveOptions	Save options for collada
CompositeCurve	A CompositeCurve is consisting of several curve segments.
CompositeCurve.Segment	The curve segment
CryptoUtils
CShape	IFC compatible C-shape profile that defined by parameters.
CullFaceMode	What face to cull
Curve	The base class of all curve implementations.
CustomObject	Meta data or custom objects used in 3D files are managed by this class.
Cylinder	Parameterized Cylinder.
Deformer	Base class for SkinDeformer and MorphTargetDeformer
Discreet3dsLoadOptions	Load options for 3DS file.
Discreet3dsSaveOptions	Save options for 3DS file.
Dish	Parameterized dish.
DracoFormat	Google Draco format Example: The following code shows how to encode and decode a Mesh to/from byte array:
DracoSaveOptions	Save options for Google draco files
Ellipse	An Ellipse defines a set of points that form the shape of ellipse.
EllipseShape	IFC compatible ellipse shape that defined by parameters.
EndPoint	The end point to trim the curve, can be a parameter value or a Cartesian point.
Entity	The base class of all entities.
Extrapolation	Extrapolation defines how to do when sampled value is out of the range which defined by the first and last key-frames.
FbxLoadOptions	Load options for Fbx format.
FbxSaveOptions	Save options for Fbx file.
FileFormat	File format definition
FileFormatType	File format type
FileStream	Created by lexchou on 6/16/2017.
FileSystem	File system encapsulation.
FMatrix4	Matrix 4x4 with all component in float type
FontFile	Font file contains definitions for glyphs, this is used to create text profile.
Frustum	The base class of Camera and Light
FVector2	A float vector with two components.
FVector3	A float vector with three components.
FVector4	A float vector with four components.
FVectorListTests
Geometry	The base class of all renderable geometric objects (like Mesh, NurbsSurface, Patch and etc.).
GlobalTransform	Global transform is similar to Transform but it's immutable while it represents the final evaluated transformation.
GltfLoadOptions	Load options for glTF format
GltfSaveOptions	Save options for glTF format.
Group	A Group represents the logical relationships of Node.
HalfSpace	HalfSpace represents a infinity space which is split by a plane, this can be used with BooleanOperator
HollowCircleShape	IFC compatible hollow circle profile.
HollowRectangleShape	IFC compatible hollow rectangular shape with both inner/outer rounding corners.
HShape	The HShape provides the defining parameters of an 'H' or 'I' shape.
Html5SaveOptions	Save options for HTML5
Int2D	Created by lexchou on 5/17/2017.
IOConfig	IO config for serialization/deserialization.
IOExtension	Utilities to write matrix/vector to binary writer
JavaXImageCodec
JtLoadOptions	Load options for Siemens JT
KeyFrame	A key frame is mainly defined by a time and a value, for some interpolation types, tangent/tension/bias/continuity is also used by calculating the final sampled value.
KeyframeSequence	The sequence of key-frames, it describes the transformation of a sampled value over time.
LambertMaterial	Material for lambert shading model
License	Provides methods to license the component.
Light	The light illuminates the scene.
Line	A polyline is a path defined by a set of points with Geometry.getControlPoints(), and connected by Line.getSegments(), which means it can also be a set of connected line segments.
LinearExtrusion	Linear extrusion takes a 2D shape as input and extends the shape in the 3rd dimension.
LoadOptions	The base class to configure options in file loading for different types
LShape	IFC compatible L-shape profile that defined by parameters.
Material	Material defines the parameters necessary for visual appearance of geometry.
MathUtils	A set of useful mathematical utilities.
Matrix4	4x4 matrix implementation.
MemoryStream	Created by lexchou on 6/13/2017.
Mesh	A mesh is made of many n-sided polygons.
Metered	Provides methods to set metered key.
Microsoft3MFFormat	File format instance for Microsoft 3MF with 3MF related utilities.
Microsoft3MFSaveOptions	Save options for Microsoft 3MF file.
MirroredProfile	IFC compatible mirror profile.
MorphTargetChannel	A MorphTargetChannel is used by MorphTargetDeformer to organize the target geometries.
MorphTargetDeformer	MorphTargetDeformer provides per-vertex animation.
MulticastEvent<EventArg>	Created by lexchou on 4/24/2017.
Node	Represents an element in the scene graph.
NurbsCurve	NURBS curve is a curve represented by NURBS(Non-uniform rational basis spline), A NURBS curve is defined by its NurbsCurve.getOrder(), a set of weighted Geometry.getControlPoints() and a NurbsCurve.getKnotVectors() The w component in control point is used as control point's weight, whatever it is a CurveDimension.TWO_DIMENSIONAL or CurveDimension.THREE_DIMENSIONAL
NurbsDirection	A 3D NurbsSurface has two direction, the NurbsSurface.getU() and NurbsSurface.getV(), the NurbsDirection defines data for each direction.
NurbsSurface	NurbsSurface is a surface represented by NURBS(Non-uniform rational basis spline), A NurbsSurface is defined by two NurbsDirectionNurbsSurface.getU() and NurbsSurface.getV().
ObjLoadOptions	Load options for wavefront obj
ObjSaveOptions	Save options for wavefront obj file
ParameterizedProfile	The base class of all parameterized profiles.
Patch	A Patch is a parametric modeling surface, similar to NurbsSurface, it's also defined by two PatchDirection, the Patch.getU() and Patch.getV().
PatchDirection	Patch's U and V direction.
PbrMaterial	Material for physically based rendering based on albedo color/metallic/roughness
PbrSpecularMaterial	Material for physically based rendering based on diffuse color/specular/glossiness
PdfFormat	Adobe's Portable Document Format Example: The following code shows how to extract all supported 3D scenes from a 3D PDF file, and write them to obj format.
PdfLoadOptions	Options for PDF loading
PdfSaveOptions	The save options in PDF exporting.
PhongMaterial	Material for blinn-phong shading model.
PixelMapping
Plane	Parameterized plane.
PlyFormat	The PLY format.
PlyLoadOptions	Load options for PLY files
PlySaveOptions	Save options for exporting scene as PLY file.
PointCloud	The point cloud contains no topology information but only the control points and the vertex elements.
PolygonBuilder	A helper class to build polygon for Mesh Example:
PolygonModifier	Utilities to modify polygons
Pose	The pose is used to store transformation matrix when the geometry is skinned.
Primitive	Base class for all primitives
Profile	2D Profile in xy plane
Property	Class to hold user-defined properties.
PropertyCollection	The collection of properties
PropertyExtensions
Pyramid	Parameterized pyramid.
Quaternion	Quaternion is usually used to perform rotation in computer graphics.
Rect	A class to represent the rectangle
RectangleShape	IFC compatible rectangular shape with rounding corners.
RectangularTorus	Parameterized rectangular torus.
RelativeRectangle	Relative rectangle The formula between relative component to absolute value is: Scale * (Reference Width) + offset So if we want it to represent an absolute value, leave all scale fields zero, and use offset fields instead.
RenderState	Render state for building the pipeline The changes made on render state will not affect the created pipeline instances.
RevolvedAreaSolid	This class represents a solid model by revolving a cross section provided by a profile about an axis.
RvmFormat	The RVM Format
RvmLoadOptions	Load options for AVEVA Plant Design Management System's RVM file.
RvmSaveOptions	Save options for Aveva PDMS RVM file.
SaveOptions	The base class to configure options in file saving for different types
Scene
SceneObject	The root class of objects that will be stored inside a scene.
ShaderMaterial	A shader material allows to describe the material by external rendering engine or shader language.
ShaderTechnique	A shader technique represents a concrete rendering implementation.
Shape	The shape describes the deformation on a set of control points, which is similar to the cluster deformer in Maya.
Skeleton	The 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.
SkinDeformer	A skin deformer contains multiple bones to work, each bone blends a part of the geometry by control point's weights.
Sphere	Parameterized sphere.
StencilState	Stencil states per face.
StlLoadOptions	Load options for STL
StlSaveOptions	Save options for STL
Stream	Created by lexchou on 12/14/2016.
Structs	Base class of struct array
StructuralMetadata	This class provides support for EXT_structural_metadata, only used in glTF.
StructuralMetadata.ClassType	Class definition in metadata
StructuralMetadata.EnumType	The enum type definition
StructuralMetadata.EnumValue	The value definition of enum type.
StructuralMetadata.Property	The property definition in meta data's classes
StructuralMetadata.PropertyTable	Property table.
SweptAreaSolid	A SweptAreaSolid constructs a geometry by sweeping a profile along a directrix.
Test3DS
Test3MF
TestA3DW
TestAmf
TestAnimations
TestApps
TestASE
TestBase
TestBlender
TestBool
TestBool3D
TestCancellation
TestCollada
TestCollections
TestCore
TestDraco
TestDXF
TestFBX6100
TestFBX7200ASCII
TestFBX7200Binary
TestFBX7300ASCII
TestFBX7400ASCII
TestFBX7500ASCII
TestFBXBase	base class for testing FBX importing and exporting
TestFBXBinary7300
TestFBXBinary7400
TestFBXBinary7500
TestFBXGeneral
TestFileConvert
TestGLTF
TestGLTF2
TestGLTF2Binary
TestGLTF2Draco
TestGLTFBinary
TestIFC_2X3
TestIFC4
TestJavaBugs
TestJavaImpls
TestJt8
TestJt9
TestLicense
TestMaterials
TestMatrix4
TestMayaAscii
TestMayaBinary
TestOBJ
TestObjectAddressing
TestObjectModel
TestPCD
TestPDF
TestPLY
TestPolygonModifiers
TestPRC
TestPrimitive
TestRVM
TestSTL
TestTransform
TestU3D
TestUSD
TestUSDA
TestUsdConvert
TestUserBugs
TestUtils
TestUtils2
TestVRML
TestWatermark
TestXBin
TestXmlReader
TestXText
TestXyz
TestZip
TestZipFile
Text	Text profile, this profile describes contours using font and text.
Texture	This class defines the texture from an external file.
TextureBase	Base class for all concrete textures.
TextureCodec	Class to manage encoders and decoders for textures.
TextureData	This class contains the raw data and format definition of a texture.
TextureSlot	Texture slot in Material, can be enumerated through material instance.
Torus	Parameterized torus.
Transform	A transform contains information that allow access to object's translate/scale/rotation or transform matrix at minimum cost This is used by local transform.
TransformBuilder	The TransformBuilder is used to build transform matrix by a chain of transformations.
TransformedCurve	A TransformedCurve gives a curve a placement by using a transformation matrix.
TrapeziumShape	IFC compatible Trapezium shape defined by parameters.
TriMesh	A TriMesh contains raw data that can be used by GPU directly.
TrimmedCurve	A bounded curve that trimmed the basis curve at both ends.
TShape	IFC compatible T-shape defined by parameters.
U3dLoadOptions	Load options for universal 3d
U3dSaveOptions	Save options for universal 3d
UsdSaveOptions	Save options for USD/USDZ formats.
UShape	IFC compatible U-shape defined by parameters.
Vector2	A vector with two components.
Vector3	A vector with three components.
Vector4	A vector with four components.
Version	Created by lexchou on 4/17/2017.
Vertex	Vertex reference, used to access the raw vertex in TriMesh.
VertexDeclaration	The declaration of a custom defined vertex's structure
VertexElement	Base class of vertex elements.
VertexElementBinormal	Defines the binormal vectors for specified components.
VertexElementDoublesTemplate	A helper class for defining concrete VertexElement implementations.
VertexElementEdgeCrease	Defines the edge crease for specified components
VertexElementFVector	A helper class for defining concrete VertexElement implementations.
VertexElementHole	Defines if specified polygon is hole
VertexElementIntsTemplate	A helper class for defining concrete VertexElement implementations.
VertexElementMaterial	Defines material index for specified components.
VertexElementNormal	Defines normal vectors for specified components.
VertexElementPolygonGroup	Defines polygon group for specified components to group related polygons together.
VertexElementSmoothingGroup	A smoothing group is a group of polygons in a polygon mesh which should appear to form a smooth surface.
VertexElementSpecular	Defines specular color for specified components.
VertexElementTangent	Defines tangent vectors for specified components.
VertexElementTemplate<T>	A helper class for defining concrete VertexElement implementations.
VertexElementUserData	Defines custom user data for specified components.
VertexElementUV	Defines the UV coordinates for specified components.
VertexElementVector4	Deprecated
VertexElementVertexColor	Defines the vertex color for specified components
VertexElementVertexCrease	Defines the vertex crease for specified components
VertexElementVisibility	Defines if specified components is visible
VertexElementWeight	Defines blend weight for specified components.
VertexField	Vertex's field memory layout description.
VertexFieldDataType	Vertex field's data type
Watermark	Utility to encode/decode blind watermark to/from a mesh.
WeightedMode	Weighted mode.
XLoadOptions	The Load options for DirectX X files.
ZShape	IFC compatible Z-shape profile defined by parameters.

Enum Summary

Enum	Description
AlphaSource	Defines whether the texture contains the alpha channel.
ApertureMode	Camera aperture modes.
Axis	The coordinate axis.
BlendFactor	Blend factor specify pixel arithmetic.
BoneLinkMode	A bone's link mode refers to the way in which a bone is connected or linked to its parent bone within a hierarchical structure.
BooleanOperation	Mesh's Boolean operation
BoundingBoxExtent	The extent of the bounding box
ColladaTransformStyle	The node's transformation style of node
CompareFunction	The compare function used in depth/stencil testing.
ComposeOrder	The order to compose transform matrix
CoordinateSystem	The left handed or right handed coordinate system.
CurveDimension	The dimension of the curves.
DracoCompressionLevel	Compression level for draco file
ExtrapolationType	Extrapolation type.
FileContentType	File content type
FrontFace	Define front- and back-facing polygons
GltfEmbeddedImageFormat	How glTF exporter will embed the textures during the exporting.
Interpolation	The key frame's interpolation type.
LightType	Light types.
MappingMode	Determines how the element is mapped to a surface.
NurbsType	NURBS types.
PatchDirectionType	Patch direction's types.
PdfLightingScheme	LightingScheme specifies the lighting to apply to 3D artwork.
PdfRenderMode	Render mode specifies the style in which the 3D artwork is rendered.
PixelFormat	The pixel's format used in texture unit.
PixelMapMode
PolygonMode	The polygon rasterization mode
PoseType	Pose type.
ProjectionType	Camera's projection types.
ReferenceMode	ReferenceMode defines how mapping information is stored and referenced by.
RotationMode	The frustum's rotation mode
RotationOrder	The order controls which rx ry rz are applied in the transformation matrix.
SkeletonType	Skeleton's types.
SplitMeshPolicy	Share vertex/control point data between sub-meshes or each sub-mesh has its own compacted data.
StencilAction	The stencil test actions
StepMode	Interpolation step mode.
TextureFilter	Filter options during texture sampling.
TextureMapping	The texture mapping type for VertexElementUV Describes which kind of texture mapping is used.
VertexElementType	The type of the vertex element, defined how it will be used in modeling.
VertexFieldSemantic	The semantic of the vertex field
WrapMode	Texture's wrap mode.

Exception Summary

Exception	Description
ExportException	Exceptions when Aspose.3D failed to export the scene to file
ImportException	Exception when Aspose.3D failed to open the specified source
NotImplementedException	Created by lexchou on 6/26/2017.
ParseException	Exception when Aspose.3D failed to parse the input.
TrialException	This is raised in Scene.Open/Scene.Save when no licenses are applied.