SCENE C++ API  2.1.6
Public Member Functions | List of all members
LSPanoramaPicture Class Reference

Interface to read panorama picture objects. More...

#include <lspanoramapicture.h>

+ Inheritance diagram for LSPanoramaPicture:

Public Member Functions

ref_ptr< LSBinaryReadergetData () const
 Returns a binary data iterator that can be used to read the picture data. More...
 
ImageType getDataType () const
 
size_t getSize () const
 
- Public Member Functions inherited from LSObject
Eigen::Matrix4d getTransformationToGlobal () const
 Calculates the transformation matrix which transforms local object coordinates to global coordinates. More...
 
void select ()
 Selects this object. More...
 
LSIterator< ref_ptr< LSObject > > getChildIterator () const
 Gets an iterator which can be used for a breadth-first iteration over all objects below the object in the object hierarchy. More...
 
ref_ptr< LSObjectgetParent () const
 Returns the parent of this object. More...
 
unsigned int getNumChildren () const
 Returns the number of children of this object. More...
 
ref_ptr< LSObjectgetChild (unsigned int n) const
 Returns the n-th child of this object. More...
 
ref_ptr< LSObjectgetChild (LSString name) const
 Returns the child of this object with a given name. More...
 
bool rmChild (unsigned int n)
 Removes a child from this object. More...
 
bool rmChild (LSString name)
 Removes a child from this object. More...
 
LSResult::Result addChild (LSString name, LSString typeName, ref_ptr< LSObject > &childOut)
 Creates a new child of the given type. More...
 
LSResult::Result generateUniqueChildName (const LSString &baseName, LSString &nameOut) const
 Generates a valid and unique name for a new child of this object based on the provided base name. More...
 
LSResult::Result setParent (ref_ptr< LSObject > newParent)
 Changes the parent of this object. More...
 
- Public Member Functions inherited from LSAttributeContainer
LSString getTypeName () const
 Gets the type name of this instance. More...
 
LSString getName () const
 Gets the name of the container. More...
 
LSResult::Result setName (LSString name)
 Sets the name of the container. More...
 
LSString getUuid () const
 Returns the unique id of the container. More...
 
LSString assignUuid ()
 Assigns a unique id to the container if the container does not not yet have a unique id. More...
 
unsigned int getNumAttributes () const
 Get the number of attributes in the container. More...
 
LSString getAttributeName (unsigned int index) const
 Get the name of an attribute in the container. More...
 
unsigned int getAttributeIndex (LSString name) const
 Get the index of an attribute in the container. More...
 
LSAttribute getAttribute (unsigned int index) const
 Get an attribute based on its index. More...
 
LSAttribute getAttribute (LSString name) const
 Get an attribute based on its name. More...
 
LSResult::Result setAttribute (unsigned int index, const LSAttribute &attribute)
 Set an attribute based on its index. More...
 
LSResult::Result setAttribute (LSString name, const LSAttribute &attribute)
 Set an attribute based on its name. More...
 
LSResult::Result addCustomAttribute (LSString name, const LSAttribute &attribute)
 Add a new custom attribute to the container. More...
 
bool removeCustomAttribute (LSString name)
 Remove a custom attribute from the container. More...
 
unsigned int getNumFields () const
 Returns the number of fields in the container. More...
 
ref_ptr< LSAttributeContainergetField (unsigned int index) const
 Returns the field at position n in the container. More...
 
ref_ptr< LSAttributeContainergetField (const LSString &name) const
 Returns the field with the given name. More...
 
LSResult::Result addField (const LSString &name, const LSString &typeName, ref_ptr< LSAttributeContainer > &fieldOut)
 Add a field to the container. More...
 
bool rmField (const LSString &name)
 Removes the field with a given name from the container. More...
 

Additional Inherited Members

- Protected Member Functions inherited from LSRefType
void ref () const
 Increments the internal reference counter. More...
 
void unref () const
 Decrements the internal reference counter. More...
 

Detailed Description

Interface to read panorama picture objects.

Version
SCENE API version 2.1.5.

Member Function Documentation

◆ getData()

ref_ptr<LSBinaryReader> getData ( ) const

Returns a binary data iterator that can be used to read the picture data.

The picture data the iterator returns are encoded in the corresponding format indicated by the value returned by the getDataType function. You may decode the data by simply using opencv, or any other library that can decode pictures. E.g.

std::vector<uint8_t> data;// This has collected the data provided by the LSBinaryReader
cv::Mat mat((int)data.size(), 1, CV_8U, const_cast<uchar*>(data.data()));
cv::Mat decodedBmp = cv::imdecode(mat, cv::IMREAD_UNCHANGED);
const auto rows = decodedBmp.rows;
const auto cols = decodedBmp.cols;

Make sure to free the binary data iterator as soon as possible, otherwise the data might stay in memory.

See also
LSBinaryReader
Returns
A nullptr in case of any unexpected errors.
Version
SCENE API Version 2.1.5

◆ getDataType()

ImageType getDataType ( ) const
Returns
the type of encoding of the binary data.
Version
SCENE API Version 2.1.5

◆ getSize()

size_t getSize ( ) const
Returns
the amount of bytes of the encoded picture. This function returns the size without loading the picture in memory as oposed to the getData function
Version
SCENE API Version 2.1.5