MeshLib Java Docs
Loading...
Searching...
No Matches
meshlib.UnitInfo Class Reference
Inheritance diagram for meshlib.UnitInfo:

Public Member Functions

 UnitInfo (java.lang.foreign.MemorySegment ptr, boolean owned, java.lang.Object owner)
 UnitInfo ()
 UnitInfo (float conversionFactor, java.lang.String prettyName, java.lang.String unitSuffix)
 UnitInfo (meshlib.UnitInfo _other)
meshlib.UnitInfo assignFromAnother (meshlib.UnitInfo _other)
float conversionFactor ()
void setConversionFactor (float value)
meshlib.std_string_view prettyName ()
void setPrettyName (java.lang.String value)
meshlib.std_string_view unitSuffix ()
void setUnitSuffix (java.lang.String value)
Public Member Functions inherited from meshlib.CppObject
final java.lang.foreign.MemorySegment rawPointer ()
final boolean isOwned ()
final void close ()
final java.lang.foreign.MemorySegment release ()

Additional Inherited Members

Protected Member Functions inherited from meshlib.CppObject
 CppObject (java.lang.foreign.MemorySegment ptr, java.util.function.Consumer< java.lang.foreign.MemorySegment > destroy, java.lang.Object owner)

Detailed Description

Information about a single measurement unit. Generated from class MR::UnitInfo.

Instances created here own their C++ objects, see CppObject.

Constructor & Destructor Documentation

◆ UnitInfo() [1/4]

meshlib.UnitInfo.UnitInfo ( java.lang.foreign.MemorySegment ptr,
boolean owned,
java.lang.Object owner )

Wraps a pointer from the C bindings. If owned, the object is destroyed when the wrapper dies. owner is kept alive as long as this wrapper is. Not for normal use.

◆ UnitInfo() [2/4]

meshlib.UnitInfo.UnitInfo ( )

Constructs an empty (default-constructed) instance.

Calls MR_UnitInfo_DefaultConstruct().

◆ UnitInfo() [3/4]

meshlib.UnitInfo.UnitInfo ( float conversionFactor,
java.lang.String prettyName,
java.lang.String unitSuffix )

Constructs MR::UnitInfo elementwise. The reference to the parameter prettyName might be preserved in the constructed object. The reference to the parameter unitSuffix might be preserved in the constructed object.

Calls MR_UnitInfo_ConstructFrom().

◆ UnitInfo() [4/4]

meshlib.UnitInfo.UnitInfo ( meshlib.UnitInfo _other)

Generated from constructor MR::UnitInfo::UnitInfo. The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object.

Calls MR_UnitInfo_ConstructFromAnother().

Member Function Documentation

◆ assignFromAnother()

meshlib.UnitInfo meshlib.UnitInfo.assignFromAnother ( meshlib.UnitInfo _other)

Generated from method MR::UnitInfo::operator=. The reference to things referred to by the parameter _other (if any) might be preserved in this object.

Calls MR_UnitInfo_AssignFromAnother().

◆ conversionFactor()

float meshlib.UnitInfo.conversionFactor ( )

This is used to convert between units. To convert from A to B, multiply by A's factor and divide by B's. Returns a pointer to a member variable of class MR::UnitInfo named conversionFactor. The reference to this object might be preserved as the return value.

Calls MR_UnitInfo_Get_conversionFactor().

◆ prettyName()

meshlib.std_string_view meshlib.UnitInfo.prettyName ( )

Returns a pointer to a member variable of class MR::UnitInfo named prettyName. The reference to this object might be preserved as the return value.

Calls MR_UnitInfo_Get_prettyName().

◆ setConversionFactor()

void meshlib.UnitInfo.setConversionFactor ( float value)

This is used to convert between units. To convert from A to B, multiply by A's factor and divide by B's. Modifies a member variable of class MR::UnitInfo named conversionFactor.

Calls MR_UnitInfo_Set_conversionFactor().

◆ setPrettyName()

void meshlib.UnitInfo.setPrettyName ( java.lang.String value)

Modifies a member variable of class MR::UnitInfo named prettyName. The reference to the parameter value might be preserved in this object in element prettyName.

Calls MR_UnitInfo_Set_prettyName().

◆ setUnitSuffix()

void meshlib.UnitInfo.setUnitSuffix ( java.lang.String value)

The short unit name that's placed after values. This may or may not start with a space. Modifies a member variable of class MR::UnitInfo named unitSuffix. The reference to the parameter value might be preserved in this object in element unitSuffix.

Calls MR_UnitInfo_Set_unitSuffix().

◆ unitSuffix()

meshlib.std_string_view meshlib.UnitInfo.unitSuffix ( )

The short unit name that's placed after values. This may or may not start with a space. Returns a pointer to a member variable of class MR::UnitInfo named unitSuffix. The reference to this object might be preserved as the return value.

Calls MR_UnitInfo_Get_unitSuffix().


The documentation for this class was generated from the following file: