nanoply::PlyProperty Class Reference

#include <nanoply.hpp>

List of all members.

Public Member Functions
int	CountValue ()
const char *	EntityName ()
const char *	EntityStr ()
bool	IsSigned ()
	PlyProperty (PlyType _t, PlyEntity _e)
	PlyProperty (PlyType _t, PlyEntity _e, std::string _n)
	PlyProperty (PlyType _t, std::string _n)
bool	SkipAsciiPropertyInFile (PlyFile &file)
bool	SkipBinaryPropertyInFile (PlyFile &file)
int	TypeSize ()
const char *	TypeStr ()
bool	WriteHeader (PlyFile &file)
Public Attributes
PlyEntity	elem
std::string	name
PlyType	type
bool	validToWrite

---

Detailed Description

PLY Property. Define a PLY property (entity and type).

Definition at line 556 of file nanoply.hpp.

---

Constructor & Destructor Documentation

nanoply::PlyProperty::PlyProperty	(	PlyType	_t,
		PlyEntity	_e
	)		[inline]

Constructor that sets the type and the entity of a standard PLY property.

Parameters:

_t	Property type.
_e	Property entity.

Definition at line 571 of file nanoply.hpp.

nanoply::PlyProperty::PlyProperty	(	PlyType	_t,
		PlyEntity	_e,
		std::string	_n
	)		[inline]

Constructor that sets the type, the entity and the name of a standard PLY property.

Parameters:

_t	Property type.
_e	Property entity.
_n	Property name.

Definition at line 580 of file nanoply.hpp.

nanoply::PlyProperty::PlyProperty	(	PlyType	_t,
		std::string	_n
	)		[inline]

Constructor that sets the type and the name of a custom PLY property.

Parameters:

_t	Property type.
_n	Property name.

Definition at line 588 of file nanoply.hpp.

---

Member Function Documentation

int nanoply::PlyProperty::CountValue

(

)

Get the number of component of the property entity.

Returns:

Number of component.

Definition at line 853 of file nanoply.hpp.

const char * nanoply::PlyProperty::EntityName

(

)

Get the name of the property entity.

Returns:

Name of the property entity.

Definition at line 708 of file nanoply.hpp.

const char * nanoply::PlyProperty::EntityStr

(

)

Get the description string of the property entity.

Returns:

Description string of the property entity.

Definition at line 658 of file nanoply.hpp.

bool nanoply::PlyProperty::IsSigned

(

)

Check if the property type is signed or unsigned.

Returns:

true = signed, false = unsigned.

Definition at line 817 of file nanoply.hpp.

bool nanoply::PlyProperty::SkipAsciiPropertyInFile

(

PlyFile &

file

)

Skip the property in an Ascii file.

Parameters:

file	Opened file.

Returns:

If successful returns true. Otherwise, it returns false.

Definition at line 865 of file nanoply.hpp.

bool nanoply::PlyProperty::SkipBinaryPropertyInFile

(

PlyFile &

file

)

Skip the property in a binary file.

Parameters:

file	Opened file.

Returns:

If successful returns true. Otherwise, it returns false.

Definition at line 929 of file nanoply.hpp.

int nanoply::PlyProperty::TypeSize

(

)

Get the size in byte of the property type.

Returns:

Size in byte of the property type.

Definition at line 771 of file nanoply.hpp.

const char * nanoply::PlyProperty::TypeStr

(

)

Get the description string of the property type.

Returns:

Description string of the property type.

Definition at line 735 of file nanoply.hpp.

bool nanoply::PlyProperty::WriteHeader

(

PlyFile &

file

)

Write the property string in the header of the PLY file.

Parameters:

file	Opened file.

Returns:

If successful returns true. Otherwise, it returns false.

Definition at line 962 of file nanoply.hpp.

---

Member Data Documentation

PlyEntity nanoply::PlyProperty::elem

Property entity.

Definition at line 562 of file nanoply.hpp.

std::string nanoply::PlyProperty::name

Property name.

Definition at line 560 of file nanoply.hpp.

PlyType nanoply::PlyProperty::type

Property type.

Definition at line 561 of file nanoply.hpp.

bool nanoply::PlyProperty::validToWrite

Property validity (necessary to write the header).

Definition at line 563 of file nanoply.hpp.

---

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

• nanoply.hpp