Interface Geometry

ig Geometry representation, mesh based.

Hierarchy

  • Geometry

Properties

collider? colliderFormat? deformation? deformationFormat? deformationXData? deformationXDataFormat? mesh? meshFormat? normalMap? normalMapFormat? parameters? preview? previewFormat?

Properties

Optional collider

collider?: string

An optional mesh to be used for collision detection. Version: OC 1.1

Optional colliderFormat

colliderFormat?: "OpenCTM" | "OBJ" | "FBX"

The mandatory format of the optional preview mesh. Allowed formats are "OpenCTM", "OBJ", "FBX". Version: OC 1.1

Optional deformation

deformation?: string

Deformation description.

Optional deformationFormat

deformationFormat?: "FFD" | "JSON"

The mandatory format of the optional deformation. Allowed formats are "FFD" and "JSON".

Optional deformationXData

deformationXData?: string

Shape-key file or other extra data, belonging to a deformation.

Optional deformationXDataFormat

deformationXDataFormat?: "glTF" | "GLB"

The mandatory format of the optional shape-key file, or other extra deformation data. Allowed formats are "glTF" and "GLB".

Optional mesh

mesh?: string

An optional mesh to be displayed as main mesh. Note, in some case a geometry does not provide it, e.g. for super deformations.

Optional meshFormat

meshFormat?: "OpenCTM" | "OBJ" | "FBX" | "DWG"

The mandatory format of the optional main mesh. Allowed formats are "OpenCTM", "OBJ", "FBX", "DWG".

Optional normalMap

normalMap?: string

An optional normal map to be applied to the main mesh.

Optional normalMapFormat

normalMapFormat?: "JPEG" | "PNG"

The mandatory format of the optional normal map. Allowed formats are "JPEG" and "PNG".

Optional parameters

parameters?: {
    NormalMapStrength?: number;
    NormalMapTiling?: boolean;
    RenderOrder?: number;
    SuperDeformation?: boolean;
}

Optional geometry-related parameters, to be resolved at client-side.

"Complexity": Describes the nominal complexity of the geometry. 100 (default) is a medium-sized, medium-complex object, such as a pillow for instance. For bigger and/or more complex objects, use complexity 200 or higher. For smaller and/or more simple objects, use complexity 50 or lower.

"SuperDeformation": Marks the geometry as a super deformation. The assigned deformation will be applied to the local geometry (if any) as well as recursively to all child geometries. Target type: Boolean

"NormalMapTiling": The Geometry Normal Map should be repeated instead of clamped outside 0..1 UV range Some 3D libraries call this "wrapping mode" if true set to "repeat", default is "clamp" Target type: Boolean Version: OC 1.1

"NormalMapStrength": Changes the influence of the Geometry Normal Map in light calculation, default: 1, by multiplying the strength of the geometry normal map with this factor. Target type: number Version: OC 1.1

"RenderOrder" FRender order for 3D libraries that render transparent objects in a separate, second pass, back to front. Negative values are rendered earlier in the process, positive values later, 0 is default and keeps library ordering. Raytracers and renderers with advanced transparency handling must ignore this! This is NOT intended for effects different from a natural/physical correct scene, i.e. it can not be used for artistic effects! Target type: number Version: OC 1.1

Type declaration

  • Optional NormalMapStrength?: number
  • Optional NormalMapTiling?: boolean
  • Optional RenderOrder?: number
  • Optional SuperDeformation?: boolean

Optional preview

preview?: string

An optional mesh to be displayed until the main mesh is loaded.

Optional previewFormat

previewFormat?: "OpenCTM" | "OBJ" | "FBX"

The mandatory format of the optional preview mesh. Allowed formats are "OpenCTM", "OBJ", "FBX".

Settings

Member Visibility

Theme

Generated using TypeDoc