Namespace uipc::builtin

Namespace List > uipc > builtin

Namespaces

Type	Name
namespace	details

Classes

Type	Name
class	ConstitutionUIDAutoRegister
class	ConstitutionUIDCollection
class	ImplicitGeometryUIDAutoRegister
class	ImplicitGeometryUIDCollection
struct	UIDInfo

Public Attributes

Type	Name
std::string_view	AbstractSimplicialComplex = "AbstractSimplicialComplex"
std::string_view	AffineBody = "AffineBody"
std::string_view	Constraint = "Constraint"
std::string_view	FiniteElement = "FiniteElement"
std::string_view	Geometry = "Geometry"
std::string_view	ImplicitGeometry = "ImplicitGeometry"
std::string_view	InterAffineBody = "InterAffineBody"
std::string_view	SimplicialComplex = "SimplicialComplex"
std::string_view	__data__ = "\_\_data\_\_"
std::string_view	__meta__ = "\_\_meta\_\_"

Public Functions

Type	Name
	UIPC_BUILTIN_ATTRIBUTE (topo) topo attribute onvertices /edges /triangles /tetrahedra ... to indicate the topological type of the element.
	UIPC_BUILTIN_ATTRIBUTE (position) position <Vector3> attribute onvertices __
	UIPC_BUILTIN_ATTRIBUTE (velocity) velocity <Vector3> attribute onvertices orvelocity <Matrix4x4> attribute oninstances (the derivative of the transform matrix).
	UIPC_BUILTIN_ATTRIBUTE (aim_position) aim_position <Vector3> attribute onvertices , indicates the aim position of the vertices if the vertices are animated.
	UIPC_BUILTIN_ATTRIBUTE (transform) transform <Matrix4x4> attribute oninstances __
	UIPC_BUILTIN_ATTRIBUTE (aim_transform) aim_transform <Matrix4x4> attribute oninstances , indicates the aim transform of the instances if the instances are animated.
	UIPC_BUILTIN_ATTRIBUTE (contact_element_id) contact_element_id <IndexT> attribute onmeta __
	UIPC_BUILTIN_ATTRIBUTE (constitution_uid) constitution_uid <U64> attribute onmeta , uid is a unique identifier for a constitution which is defined in the libuipc specification.
	UIPC_BUILTIN_ATTRIBUTE (extra_constitution_uids) extra_constitution_uids <VectorXu64> attribute onmeta , extra constitutions that are applied to the geometry.
	UIPC_BUILTIN_ATTRIBUTE (constraint_uid) constraint_uid <U64> attribute onmeta , uid is a unique identifier for a constraint which is defined in the libuipc specification.
	UIPC_BUILTIN_ATTRIBUTE (implicit_geometry_uid) implicit_geometry_uid <U64> attribute onmeta , uid is a unique identifier for an implicit geometry which is defined in the libuipc specification.
	UIPC_BUILTIN_ATTRIBUTE (is_surf) is_surf <IndexT> attribute onvertices /edges /triangles /tetrahedra ... to indicate if the element is a surface element.
	UIPC_BUILTIN_ATTRIBUTE (is_facet) is_facet <IndexT> attribute onvertices /edges /triangles /tetrahedra to indicate if the element is a facet element.
	UIPC_BUILTIN_ATTRIBUTE (orient) orient <IndexT>[-1,0,1] attribute ontriangles to indicate the orientation of the triangle.
	UIPC_BUILTIN_ATTRIBUTE (parent_id) parent_id <IndexT> attribute onedges /triangles , indicates the parent simplex id
	UIPC_BUILTIN_ATTRIBUTE (is_fixed) is_fixed <IndexT>[0,1] attribute, indicates if theinstance orvertex is fixed.
	UIPC_BUILTIN_ATTRIBUTE (is_constrained) is_constrained <IndexT>[0,1] attribute, indicates if theinstance orvertex is constrained.
	UIPC_BUILTIN_ATTRIBUTE (is_dynamic) is_dynamic <IndexT>[0,1] attribute, indicates if theinstance orvertex is is dynamic.
	UIPC_BUILTIN_ATTRIBUTE (volume) volume <Float> attribute onvertices .
	UIPC_BUILTIN_ATTRIBUTE (mass_density) mass_density <Float> attribute onvertices ormeta .
	UIPC_BUILTIN_ATTRIBUTE (gravity) gravity <Vector3> attribute oninstance orvertices .
	UIPC_BUILTIN_ATTRIBUTE (thickness) thickness <Float> attribute onvertices to indicate the shell thickness (radius) of the vertices which is valid when dealing with codimensional geometries.
	UIPC_BUILTIN_ATTRIBUTE (backend_fem_vertex_offset) backend_fem_vertex_offset <IndexT> attribute onmeta to indicate the offset of the vertex in the FEM system.
	UIPC_BUILTIN_ATTRIBUTE (backend_abd_body_offset) backend_abd_body_offset <IndexT> attribute onmeta to indicate the offset of the body(instance) in the ABD system.
	UIPC_BUILTIN_ATTRIBUTE (dof_offset) dof_offset <IndexT> attribute onmeta to indicate the degree of freedom offset of this geometry in the whole system.
	UIPC_BUILTIN_ATTRIBUTE (dof_count) dof_count <IndexT> attribute onmeta to indicate the degree of freedom count of this geometry in the whole system.
	UIPC_BUILTIN_ATTRIBUTE (self_collision) self_collision <IndexT>[0,1] attribute onmeta to indicate if the geometry needs self-collision detection.

Public Attributes Documentation

variable AbstractSimplicialComplex

std::string_view uipc::builtin::AbstractSimplicialComplex;

---

variable AffineBody

std::string_view uipc::builtin::AffineBody;

---

variable Constraint

std::string_view uipc::builtin::Constraint;

---

variable FiniteElement

std::string_view uipc::builtin::FiniteElement;

---

variable Geometry

std::string_view uipc::builtin::Geometry;

---

variable ImplicitGeometry

std::string_view uipc::builtin::ImplicitGeometry;

---

variable InterAffineBody

std::string_view uipc::builtin::InterAffineBody;

---

variable SimplicialComplex

std::string_view uipc::builtin::SimplicialComplex;

---

variable __data__

std::string_view uipc::builtin::__data__;

---

variable __meta__

std::string_view uipc::builtin::__meta__;

---

Public Functions Documentation

function UIPC_BUILTIN_ATTRIBUTE

topo attribute onvertices /edges /triangles /tetrahedra ... to indicate the topological type of the element.

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    topo
) 

---

function UIPC_BUILTIN_ATTRIBUTE

position <Vector3> attribute onvertices __

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    position
) 

---

function UIPC_BUILTIN_ATTRIBUTE

velocity <Vector3> attribute onvertices orvelocity <Matrix4x4> attribute oninstances (the derivative of the transform matrix).

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    velocity
) 

---

function UIPC_BUILTIN_ATTRIBUTE

aim_position <Vector3> attribute onvertices , indicates the aim position of the vertices if the vertices are animated.

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    aim_position
) 

---

function UIPC_BUILTIN_ATTRIBUTE

transform <Matrix4x4> attribute oninstances __

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    transform
) 

---

function UIPC_BUILTIN_ATTRIBUTE

aim_transform <Matrix4x4> attribute oninstances , indicates the aim transform of the instances if the instances are animated.

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    aim_transform
) 

---

function UIPC_BUILTIN_ATTRIBUTE

contact_element_id <IndexT> attribute onmeta __

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    contact_element_id
) 

---

function UIPC_BUILTIN_ATTRIBUTE

constitution_uid <U64> attribute onmeta , uid is a unique identifier for a constitution which is defined in the libuipc specification.

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    constitution_uid
) 

---

function UIPC_BUILTIN_ATTRIBUTE

extra_constitution_uids <VectorXu64> attribute onmeta , extra constitutions that are applied to the geometry.

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    extra_constitution_uids
) 

---

function UIPC_BUILTIN_ATTRIBUTE

constraint_uid <U64> attribute onmeta , uid is a unique identifier for a constraint which is defined in the libuipc specification.

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    constraint_uid
) 

---

function UIPC_BUILTIN_ATTRIBUTE

implicit_geometry_uid <U64> attribute onmeta , uid is a unique identifier for an implicit geometry which is defined in the libuipc specification.

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    implicit_geometry_uid
) 

---

function UIPC_BUILTIN_ATTRIBUTE

is_surf <IndexT> attribute onvertices /edges /triangles /tetrahedra ... to indicate if the element is a surface element.

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    is_surf
) 

---

function UIPC_BUILTIN_ATTRIBUTE

is_facet <IndexT> attribute onvertices /edges /triangles /tetrahedra to indicate if the element is a facet element.

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    is_facet
) 

---

function UIPC_BUILTIN_ATTRIBUTE

orient <IndexT>[-1,0,1] attribute ontriangles to indicate the orientation of the triangle.

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    orient
) 

1) 0 is the default value, which means the orientation is not determined, or the triangle is not a surface triangle. 2) 1 means outward the tetrahedron 3) -1 means inward the tetrahedron.

---

function UIPC_BUILTIN_ATTRIBUTE

parent_id <IndexT> attribute onedges /triangles , indicates the parent simplex id

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    parent_id
) 

---

function UIPC_BUILTIN_ATTRIBUTE

is_fixed <IndexT>[0,1] attribute, indicates if theinstance orvertex is fixed.

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    is_fixed
) 

'Fixed' means the vertices are not influenced by its constitution and kinetic, keeping the position unchanged. They may be fixed with a certain position, or they are animated with a certain aim position.

1) 0 means the instance or vertex is not fixed. 2) 1 means the instance or vertex is fixed.

---

function UIPC_BUILTIN_ATTRIBUTE

is_constrained <IndexT>[0,1] attribute, indicates if theinstance orvertex is constrained.

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    is_constrained
) 

'Constrained' means the instances or vertices are trying to obey the constraints.

1) 0 means the instance or vertex is not constrained. 2) 1 means the instance or vertex is constrained.

---

function UIPC_BUILTIN_ATTRIBUTE

is_dynamic <IndexT>[0,1] attribute, indicates if theinstance orvertex is is dynamic.

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    is_dynamic
) 

'Dynamic' means the kinetic of instances or vertices is considered.

1) 0 means the the kinetic of the instance or vertex is not considered. 2) 1 means the the kinetic of the instance or vertex is considered.

---

function UIPC_BUILTIN_ATTRIBUTE

volume <Float> attribute onvertices .

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    volume
) 

---

function UIPC_BUILTIN_ATTRIBUTE

mass_density <Float> attribute onvertices ormeta .

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    mass_density
) 

---

function UIPC_BUILTIN_ATTRIBUTE

gravity <Vector3> attribute oninstance orvertices .

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    gravity
) 

If attribute exists, backend will take this value as the gravity of the instance or vertices, instead of the global gravity set in the scene configuration.

---

function UIPC_BUILTIN_ATTRIBUTE

thickness <Float> attribute onvertices to indicate the shell thickness (radius) of the vertices which is valid when dealing with codimensional geometries.

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    thickness
) 

---

function UIPC_BUILTIN_ATTRIBUTE

backend_fem_vertex_offset <IndexT> attribute onmeta to indicate the offset of the vertex in the FEM system.

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    backend_fem_vertex_offset
) 

---

function UIPC_BUILTIN_ATTRIBUTE

backend_abd_body_offset <IndexT> attribute onmeta to indicate the offset of the body(instance) in the ABD system.

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    backend_abd_body_offset
) 

---

function UIPC_BUILTIN_ATTRIBUTE

dof_offset <IndexT> attribute onmeta to indicate the degree of freedom offset of this geometry in the whole system.

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    dof_offset
) 

---

function UIPC_BUILTIN_ATTRIBUTE

dof_count <IndexT> attribute onmeta to indicate the degree of freedom count of this geometry in the whole system.

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    dof_count
) 

---

function UIPC_BUILTIN_ATTRIBUTE

self_collision <IndexT>[0,1] attribute onmeta to indicate if the geometry needs self-collision detection.

uipc::builtin::UIPC_BUILTIN_ATTRIBUTE (
    self_collision
) 

---

---

The documentation for this class was generated from the following file include/uipc/builtin/attribute_name.h