Module vrImagePtr :: Class vrImagePtr

Class vrImagePtr

 object --+        
          |        
??.instance --+    
              |    
       ImagePtr --+
                  |
                 vrImagePtr

See vrdImage in API v2.

A wrapper class for the OpenSG ImagePtr.

Instance Methods

__init__(source)
The constructor of the vrImagePtr class.

vrFieldAccess

fields()
Returns the field access object to get access to all fields.

int unsigned (32bit)

getID()
Returns the image id.

ImagePtr

getPtr()
Return the OpenSG ImagePtr.

bool

isValid()
Returns true when the image is valid.

bool

read(name)
Loads an image via filename.

Inherited from ImagePtr: __reduce__

Inherited from unreachable.instance: __new__

Class Variables
	__instance_size__ = `64`

Method Details

init(source)
(Constructor)

The constructor of the vrImagePtr class. There are three valid versions:

vrImagePtr() Creates a vrImagePtr object.

vrImagePtr(source) Creates a vrImagePtr object from an unsigned int.

vrImagePtr(source) Creates a vrImagePtr object from an ImagePtr.

Parameters:

source (unsigned int or vrImagePtr) - The source (Optional).

Overrides: ImagePtr.__init__

fields()

Returns the field access object to get access to all fields. Take a look at the vrFieldAccess documentation to see how to manipulate the value of the fields.

Returns: vrFieldAccess: The field access object.

getID()

Returns the image id.

Returns: int unsigned (32bit): The id of the image.

getPtr()

Return the OpenSG ImagePtr.

Returns: ImagePtr: A pointer to the image.

isValid()

Returns true when the image is valid.

Returns: bool: Returns true when the image is valid, false otherwise.

read(name)

Loads an image via filename.