Kanzi 3.9.10
Mesh Class Reference

Mesh stores the geometry data for rendering Model3D nodes. More...

Inheritance diagram for Mesh:
[legend]

Classes

class  CreateInfo
 Use Mesh.CreateInfo to describe and create meshes. More...
 

Static Public Member Functions

static ObjectRef< Meshcreate (Domain domain, Mesh.CreateInfo createInfo, String name)
 Creates a mesh with specified mesh creation parameters.
 
static ObjectRef< MeshcreateBox (Domain domain, Vector3 size, long subdivisions, String name, Material material)
 Creates a mesh with a box shape in a single cluster.
 
static ObjectRef< MeshcreateIcosphere (Domain domain, float radius, long subdivisions, String name, Material material)
 Creates a mesh with a sphere shape in a single cluster.
 
static ObjectRef< MeshcreatePlane (Domain domain, float width, float height, long subdivisions, boolean invertU, boolean invertV, String name, Material material)
 Creates a plane shape.
 
static ObjectRef< MeshcreateQuadsphere (Domain domain, float radius, long subdivisions, String name, Material material)
 Creates a mesh with a sphere shape in a single cluster.
 
static ObjectRef< MeshcreateSphere (Domain domain, float radius, long segmentCount, long rowCount, String name, Material material)
 Creates a mesh with a sphere shape in a single cluster.
 

Static Public Attributes

static final Metaclass metaclass = com.rightware.kanzi.metadata.MeshMetadata.metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from GPUResource
static final Metaclass metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from Resource
static final Metaclass metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from KanziObject
static final Metaclass metaclass = new AbstractMetaclass("Kanzi.Object")
 The Metaclass for the class.
 

Additional Inherited Members

- Public Member Functions inherited from Resource
String getName ()
 Gets the resource name.
 
String getUrl ()
 Gets the resource URL.
 
void setKeepAlive (boolean keepAlive)
 Sets the keep alive flag.
 
- Public Member Functions inherited from KanziObject
boolean equals (Object object)
 
Domain getDomain ()
 Returns the domain the object belongs to.
 
Metaclass getDynamicMetaclass ()
 Returns the metaclass of the dynamic type of the object.
 
long getNative ()
 Gets a pointer to the backing C++ instance.
 
TDataType getOptionalProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type, but does not use the default value if there are no inputs to the property value.
 
TDataType getProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type.
 
int hashCode ()
 
boolean hasValue (PropertyType< TDataType > propertyType)
 Evaluates whether there are any inputs into the property value.
 
boolean isStale ()
 Test if the object is stale i.e.
 
void removeLocalValue (PropertyType< TDataType > propertyType)
 Removes the local value associated with the property.
 
void setProperty (PropertyType< TDataType > propertyType, TDataType value)
 Sets the local value of a property type.
 
ObjectRef< TTypetryCreateObjectRef (Class< TType > clazz)
 Tries to create an owning ObjectRef instance to this KanziObject.
 
- Public Attributes inherited from ResourceMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Resource")
 Metaclass for Resource.
 
- Public Attributes inherited from GPUResourceMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.GPUResource")
 Metaclass for GPUResource.
 
- Public Attributes inherited from MeshMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Mesh")
 Metaclass for Mesh.
 

Detailed Description

Mesh stores the geometry data for rendering Model3D nodes.

A mesh has one or more clusters. Each cluster has material and primitives. Primitives are typically triangles stored as vertex data and index data.

Member Function Documentation

◆ create()

static ObjectRef< Mesh > create ( Domain domain,
Mesh.CreateInfo createInfo,
String name )
static

Creates a mesh with specified mesh creation parameters.

To create a mesh, you need a Mesh.CreateInfo structure. When you create a Mesh, Kanzi deploys the primitive vertex and index data to GPU memory.

Parameters
domainDomain for the mesh.
createInfoMesh creation parameters.
nameName of the mesh.
Returns
Mesh handle.

◆ createBox()

static ObjectRef< Mesh > createBox ( Domain domain,
Vector3 size,
long subdivisions,
String name,
Material material )
static

Creates a mesh with a box shape in a single cluster.

Parameters
domainThe domain to which the mesh belongs.
sizeSize of the box.
subdivisionsAmount of subdivision to apply.
nameName of the mesh.
materialMaterial handle for the cluster. If set, leave the materialURL parameter empty.
Returns
Mesh handle.

◆ createIcosphere()

static ObjectRef< Mesh > createIcosphere ( Domain domain,
float radius,
long subdivisions,
String name,
Material material )
static

Creates a mesh with a sphere shape in a single cluster.

Parameters
domainThe domain to which the mesh belongs.
radiusRadius of the sphere.
subdivisionsNumber of subdivision to apply.
nameName of the mesh.
materialMaterial handle for the cluster.
Returns
Mesh handle.

◆ createPlane()

static ObjectRef< Mesh > createPlane ( Domain domain,
float width,
float height,
long subdivisions,
boolean invertU,
boolean invertV,
String name,
Material material )
static

Creates a plane shape.

Parameters
domainThe domain to which the mesh belongs.
widthWidth of the plane, that is, the size along the x axis.
heightHeight of the plane, that is, the size along the y axis.
subdivisionsAmount of subdivision to apply.
invertUWhether to invert the first texture coordinate.
invertVWhether to invert the second texture coordinate.
nameName of the mesh.
materialMaterial handle for the cluster. If set, leave the materialURL parameter empty.
Returns
Mesh handle.

◆ createQuadsphere()

static ObjectRef< Mesh > createQuadsphere ( Domain domain,
float radius,
long subdivisions,
String name,
Material material )
static

Creates a mesh with a sphere shape in a single cluster.

Parameters
domainThe domain to which the mesh belongs.
radiusRadius of the sphere.
subdivisionsNumber of subdivision to apply.
nameName of the mesh.
materialMaterial handle for the cluster.
Returns
Mesh handle.

◆ createSphere()

static ObjectRef< Mesh > createSphere ( Domain domain,
float radius,
long segmentCount,
long rowCount,
String name,
Material material )
static

Creates a mesh with a sphere shape in a single cluster.

Parameters
domainThe domain to which the mesh belongs.
radiusRadius of the sphere
segmentCountNumber of segments for the shape
rowCountNumber of rows for the shape
nameName of the mesh.
materialMaterial handle for the cluster.
Returns
Mesh handle.