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

Public Member Functions

 std_shared_ptr_MR_VisualObject (java.lang.foreign.MemorySegment ptr, boolean owned, java.lang.Object owner)
 std_shared_ptr_MR_VisualObject ()
 std_shared_ptr_MR_VisualObject (meshlib.std_shared_ptr_MR_VisualObject other)
void assignFromAnother (meshlib.std_shared_ptr_MR_VisualObject other)
meshlib.VisualObject get ()
boolean has_value ()
int use_count ()
void reset ()
void assign (meshlib.VisualObject ptr)
void assignNonOwning (meshlib.VisualObject ptr)
 std_shared_ptr_MR_VisualObject (meshlib.std_shared_ptr_const_void ownership, meshlib.VisualObject ptr)
void AssignAliasing (meshlib.std_shared_ptr_const_void ownership, meshlib.VisualObject ptr)
meshlib.std_shared_ptr_void convertTo_MR_std_shared_ptr_void ()
void AssignTo_MR_std_shared_ptr_void (meshlib.std_shared_ptr_void _target)
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 ()

Static Public Member Functions

static meshlib.std_shared_ptr_MR_VisualObject constructFromValue (meshlib.VisualObject value)
static meshlib.std_shared_ptr_MR_VisualObject construct (meshlib.VisualObject ptr)
static meshlib.std_shared_ptr_MR_VisualObject constructNonOwning (meshlib.VisualObject ptr)

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

Wraps a pointer to a single shared reference-counted heap-allocated MR::VisualObject.

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

Constructor & Destructor Documentation

◆ std_shared_ptr_MR_VisualObject() [1/4]

meshlib.std_shared_ptr_MR_VisualObject.std_shared_ptr_MR_VisualObject ( 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.

◆ std_shared_ptr_MR_VisualObject() [2/4]

meshlib.std_shared_ptr_MR_VisualObject.std_shared_ptr_MR_VisualObject ( )

Constructs an empty (default-constructed) instance.

Calls MR_std_shared_ptr_MR_VisualObject_DefaultConstruct().

◆ std_shared_ptr_MR_VisualObject() [3/4]

meshlib.std_shared_ptr_MR_VisualObject.std_shared_ptr_MR_VisualObject ( meshlib.std_shared_ptr_MR_VisualObject other)

Constructs a copy of another instance. The source remains alive. The reference to the parameter other might be preserved in the constructed object.

Calls MR_std_shared_ptr_MR_VisualObject_ConstructFromAnother().

◆ std_shared_ptr_MR_VisualObject() [4/4]

meshlib.std_shared_ptr_MR_VisualObject.std_shared_ptr_MR_VisualObject ( meshlib.std_shared_ptr_const_void ownership,
meshlib.VisualObject ptr )

The aliasing constructor. Create a new instance, copying ownership from an existing shared pointer and storing an arbitrary raw pointer. The input pointer can be reinterpreted from any other std::shared_ptr<T> to avoid constructing a new std::shared_ptr<void>. The reference to the parameter ptr might be preserved in the constructed object.

Calls MR_std_shared_ptr_MR_VisualObject_ConstructAliasing().

Member Function Documentation

◆ assign()

void meshlib.std_shared_ptr_MR_VisualObject.assign ( meshlib.VisualObject ptr)

Overwrite the existing instance, taking ownership of an existing pointer. The previously owned object, if any, has its reference count decremented.

Calls MR_std_shared_ptr_MR_VisualObject_Assign().

◆ AssignAliasing()

void meshlib.std_shared_ptr_MR_VisualObject.AssignAliasing ( meshlib.std_shared_ptr_const_void ownership,
meshlib.VisualObject ptr )

The aliasing assignment. Overwrite an existing instance, copying ownership from an existing shared pointer and storing an arbitrary raw pointer. The input pointer can be reinterpreted from any other std::shared_ptr<T> to avoid constructing a new std::shared_ptr<void>. The reference to the parameter ptr might be preserved in this object.

Calls MR_std_shared_ptr_MR_VisualObject_AssignAliasing().

◆ assignFromAnother()

void meshlib.std_shared_ptr_MR_VisualObject.assignFromAnother ( meshlib.std_shared_ptr_MR_VisualObject other)

Assigns the contents from another instance. Both objects remain alive after the call. The reference to the parameter other might be preserved in this object.

Calls MR_std_shared_ptr_MR_VisualObject_AssignFromAnother().

◆ assignNonOwning()

void meshlib.std_shared_ptr_MR_VisualObject.assignNonOwning ( meshlib.VisualObject ptr)

Overwrite the existing instance with a non-owning pointer. The previously owned object, if any, has its reference count decremented. The reference to the parameter ptr might be preserved in this object.

Calls MR_std_shared_ptr_MR_VisualObject_AssignNonOwning().

◆ AssignTo_MR_std_shared_ptr_void()

void meshlib.std_shared_ptr_MR_VisualObject.AssignTo_MR_std_shared_ptr_void ( meshlib.std_shared_ptr_void _target)

Overwrites an existing std::shared_ptr<void> to point to the same object as this instance.

Calls MR_std_shared_ptr_MR_VisualObject_AssignTo_MR_std_shared_ptr_void().

◆ construct()

meshlib.std_shared_ptr_MR_VisualObject meshlib.std_shared_ptr_MR_VisualObject.construct ( meshlib.VisualObject ptr)
static

Create a new instance, taking ownership of an existing pointer.

Calls MR_std_shared_ptr_MR_VisualObject_Construct().

◆ constructFromValue()

meshlib.std_shared_ptr_MR_VisualObject meshlib.std_shared_ptr_MR_VisualObject.constructFromValue ( meshlib.VisualObject value)
static

Construct from a value. The reference to the parameter value might be preserved in the constructed object.

Calls MR_std_shared_ptr_MR_VisualObject_ConstructFromValue().

◆ constructNonOwning()

meshlib.std_shared_ptr_MR_VisualObject meshlib.std_shared_ptr_MR_VisualObject.constructNonOwning ( meshlib.VisualObject ptr)
static

Create a new instance, storing a non-owning pointer. The reference to the parameter ptr might be preserved in the constructed object.

Calls MR_std_shared_ptr_MR_VisualObject_ConstructNonOwning().

◆ convertTo_MR_std_shared_ptr_void()

meshlib.std_shared_ptr_void meshlib.std_shared_ptr_MR_VisualObject.convertTo_MR_std_shared_ptr_void ( )

Creates an untyped std::shared_ptr<void> pointing to the same object as the source typed pointer.

Calls MR_std_shared_ptr_MR_VisualObject_ConvertTo_MR_std_shared_ptr_void().

◆ get()

meshlib.VisualObject meshlib.std_shared_ptr_MR_VisualObject.get ( )

Returns the stored pointer, possibly null. The reference to this object might be preserved as the return value.

Calls MR_std_shared_ptr_MR_VisualObject_get().

◆ has_value()

boolean meshlib.std_shared_ptr_MR_VisualObject.has_value ( )

Returns true if non-null.

Calls MR_std_shared_ptr_MR_VisualObject_has_value().

◆ reset()

void meshlib.std_shared_ptr_MR_VisualObject.reset ( )

Resets the pointer to null.

Calls MR_std_shared_ptr_MR_VisualObject_reset().

◆ use_count()

int meshlib.std_shared_ptr_MR_VisualObject.use_count ( )

How many shared pointers share the managed object. Zero if no object is being managed. This being zero usually conincides with MR_std_shared_ptr_MR_VisualObject_get() returning null, but is ultimately orthogonal. Note that in multithreaded environments, the only safe way to use this number is comparing it with zero. Positive values might change by the time you get to use them.

Calls MR_std_shared_ptr_MR_VisualObject_use_count().


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