import from .obj wavefront files More...

#include <vtkOBJImporter.h>

Inheritance diagram for vtkOBJImporter:

Collaboration diagram for vtkOBJImporter:

Public Types
typedef vtkImporter	Superclass

Public Types inherited from vtkImporter
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkOBJImporter *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

std::string	GetOutputsDescription () override
	Get a printable string describing all outputs.

std::string	GetOutputDescription (int idx)
	Get a string describing an output.


void	SetFileName (VTK_FILEPATH const char *arg)
	Specify the name of the file to read.

void	SetFileNameMTL (VTK_FILEPATH const char *arg)
	Specify the name of the file to read.

void	SetTexturePath (VTK_FILEPATH const char *path)
	Specify the name of the file to read.

VTK_FILEPATH const char *	GetFileName () const
	Specify the name of the file to read.

VTK_FILEPATH const char *	GetFileNameMTL () const
	Specify the name of the file to read.

VTK_FILEPATH const char *	GetTexturePath () const
	Specify the name of the file to read.

Public Member Functions inherited from vtkImporter
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkImporter *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

VTK_UNBLOCKTHREADS bool	Update ()
	Import the actors, cameras, lights and properties into a vtkRenderWindow and return if it was sucessful of not.

void	Read ()
	Import the actors, cameras, lights and properties into a vtkRenderWindow.

virtual std::string	GetOutputsDescription ()
	Recover a printable string that let importer implementation Describe their outputs.

virtual vtkIdType	GetNumberOfAnimations ()
	Get the number of available animations.

virtual std::string	GetAnimationName (vtkIdType vtkNotUsed(animationIndex))
	Get the name of an animation.

virtual vtkIdType	GetNumberOfCameras ()
	Get the number of available cameras.

virtual std::string	GetCameraName (vtkIdType vtkNotUsed(camIndex))
	Get the name of a camera.

virtual void	SetCamera (vtkIdType vtkNotUsed(camIndex))
	Enable a specific camera.

virtual bool	GetTemporalInformation (vtkIdType animationIndex, double frameRate, int &nbTimeSteps, double timeRange[2], vtkDoubleArray *timeSteps)
	Get temporal information for the provided animationIndex and frameRate.

virtual void	UpdateTimeStep (double timeValue)
	Import the actors, camera, lights and properties at a specific time value.

virtual bool	UpdateAtTimeValue (double timeValue)
	Import the actors, camera, lights and properties at a specific time value.

virtual vtkRenderer *	GetRenderer ()
	Get the renderer that contains the imported actors, cameras and lights.

virtual vtkDataAssembly *	GetSceneHierarchy ()
	Get the hierarchy of actors, cameras and lights in the renderer.

vtkActorCollection *	GetImportedActors ()
	Get collection of actors, cameras and lights that were imported by this importer.

vtkCollection *	GetImportedCameras ()
	Get collection of actors, cameras and lights that were imported by this importer.

vtkLightCollection *	GetImportedLights ()
	Get collection of actors, cameras and lights that were imported by this importer.

virtual void	SetRenderWindow (vtkRenderWindow *)
	Set the vtkRenderWindow to contain the imported actors, cameras and lights, If no vtkRenderWindow is set, one will be created and can be obtained with the GetRenderWindow method.

virtual vtkRenderWindow *	GetRenderWindow ()
	Set the vtkRenderWindow to contain the imported actors, cameras and lights, If no vtkRenderWindow is set, one will be created and can be obtained with the GetRenderWindow method.

virtual void	EnableAnimation (vtkIdType vtkNotUsed(animationIndex))
	Enable/Disable/Get the status of specific animations.

virtual void	DisableAnimation (vtkIdType vtkNotUsed(animationIndex))
	Enable/Disable/Get the status of specific animations.

virtual bool	IsAnimationEnabled (vtkIdType vtkNotUsed(animationIndex))
	Enable/Disable/Get the status of specific animations.

virtual void	SetImportArmature (bool)
	Enable/Disable armature actors import if supported.

virtual bool	GetImportArmature ()
	Enable/Disable armature actors import if supported.

virtual void	ImportArmatureOn ()
	Enable/Disable armature actors import if supported.

virtual void	ImportArmatureOff ()
	Enable/Disable armature actors import if supported.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkOBJImporter *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOBJImporter *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkImporter
static vtkTypeBool	IsTypeOf (const char *type)

static vtkImporter *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOBJImporter ()

	~vtkOBJImporter () override

int	ImportBegin () override

void	ImportEnd () override

void	ReadData () override

Protected Member Functions inherited from vtkImporter
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkImporter ()

	~vtkImporter () override

virtual int	ImportBegin ()

virtual void	ImportEnd ()

virtual void	ImportActors (vtkRenderer *)

virtual void	ImportCameras (vtkRenderer *)

virtual void	ImportLights (vtkRenderer *)

virtual void	ImportProperties (vtkRenderer *)

virtual void	ReadData ()

void	SetUpdateStatus (UpdateStatusEnum updateStatus)
	Set the update status.

UpdateStatusEnum	GetUpdateStatus ()
	Get the update status.

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkSmartPointer< vtkOBJPolyDataProcessor >	Impl

Protected Attributes inherited from vtkImporter
vtkRenderer *	Renderer = nullptr

vtkRenderWindow *	RenderWindow = nullptr

vtkSmartPointer< vtkDataAssembly >	SceneHierarchy

vtkNew< vtkActorCollection >	ActorCollection

vtkNew< vtkCollection >	CameraCollection

vtkNew< vtkLightCollection >	LightCollection

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Protected Types inherited from vtkImporter
enum class	UpdateStatusEnum : bool { SUCCESS , FAILURE }

Static Protected Member Functions inherited from vtkImporter
static std::string	GetDataSetDescription (vtkDataSet *ds, vtkIndent indent)

static std::string	GetArrayDescription (vtkAbstractArray *array, vtkIndent indent)

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

import from .obj wavefront files

Note: {updated by peter karasev, 2015 to read texture coordinates + material properties}; {An example of a supported (*).mtl file is show below. Lighting values and texture images are specified, and a corresponding vtkActor with properties and vtkTexture will be created upon import. }

Wavefront material file saved from Meshlab

newmtl material_0 Ka 0.400000 0.400000 0.400000 Kd 0.5 0.5 0.5 Ks 0.85 0.9 0.9 illum 2 Ns 0.000000 map_Kd map1024.png

newmtl material_1 Ka 0.200000 0.200000 0.200000 Kd 0.666667 0.666667 0.666667 Ks 1.000000 0.9 1.000000 illum 2 Ns 0.000000 map_Kd flare.jpg

This importer doesn't support scene hierarchy API

This importer supports the collection API

                   from Wavefront .obj & associated .mtl files.

Thanks - Peter Karasev (Georgia Tech / Keysight Technologies Inc),:: Allen Tannenbaum (SUNY Stonybrook), Patricio Vela (Georgia Tech)

See also: vtkImporter

Examples:: vtkOBJImporter (Examples)

Online Examples:

ImportToExport

OBJImporter

CombineImportedActors

Tests:: vtkOBJImporter (Tests)

Definition at line 100 of file vtkOBJImporter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkImporter vtkOBJImporter::Superclass

Definition at line 105 of file vtkOBJImporter.h.

Constructor & Destructor Documentation

◆ vtkOBJImporter()

vtkOBJImporter::vtkOBJImporter ( )

protected

◆ ~vtkOBJImporter()

vtkOBJImporter::~vtkOBJImporter ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkOBJImporter * vtkOBJImporter::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkOBJImporter::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkOBJImporter::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImporter.

◆ SafeDownCast()

static vtkOBJImporter * vtkOBJImporter::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkOBJImporter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImporter.

◆ NewInstance()

vtkOBJImporter * vtkOBJImporter::NewInstance ( ) const

◆ PrintSelf()

void vtkOBJImporter::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkImporter.