VTK  9.3.20240614
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
vtk3DSImporter Class Reference

imports 3D Studio files. More...

#include <vtk3DSImporter.h>

Inheritance diagram for vtk3DSImporter:
[legend]
Collaboration diagram for vtk3DSImporter:
[legend]

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.
 
vtk3DSImporterNewInstance () 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 the outputs.
 
FILE * GetFileFD ()
 Return the file pointer to the open file.
 
 vtkSetFilePathMacro (FileName)
 Specify the name of the file to read.
 
 vtkGetFilePathMacro (FileName)
 Specify the name of the file to read.
 
virtual void SetComputeNormals (vtkTypeBool)
 Set/Get the computation of normals.
 
virtual vtkTypeBool GetComputeNormals ()
 Set/Get the computation of normals.
 
virtual void ComputeNormalsOn ()
 Set/Get the computation of normals.
 
virtual void ComputeNormalsOff ()
 Set/Get the computation of normals.
 
- 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.
 
vtkImporterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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 vtkRendererGetRenderer ()
 Get the renderer that contains the imported actors, cameras and lights.
 
virtual vtkDataAssemblyGetSceneHierarchy ()
 Get the hierarchy of actors, cameras and lights in the renderer.
 
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 vtkRenderWindowGetRenderWindow ()
 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.
 
void Read ()
 Import the actors, cameras, lights and properties into a vtkRenderWindow.
 
void Update ()
 Import the actors, cameras, lights and properties into a vtkRenderWindow.
 
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.
 
- 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.
 
vtkCommandGetCommand (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 vtk3DSImporterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtk3DSImporterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImporter
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImporterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 vtkObjectBaseNew ()
 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.
 

Public Attributes

vtk3DSOmniLight * OmniList
 
vtk3DSSpotLight * SpotLightList
 
vtk3DSCamera * CameraList
 
vtk3DSMesh * MeshList
 
vtk3DSMaterial * MaterialList
 
vtk3DSMatProp * MatPropList
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtk3DSImporter ()
 
 ~vtk3DSImporter () override
 
int ImportBegin () override
 
void ImportEnd () override
 
void ImportActors (vtkRenderer *renderer) override
 
void ImportCameras (vtkRenderer *renderer) override
 
void ImportLights (vtkRenderer *renderer) override
 
void ImportProperties (vtkRenderer *renderer) override
 
vtkPolyDataGeneratePolyData (vtk3DSMesh *meshPtr)
 
int Read3DS ()
 
- Protected Member Functions inherited from vtkImporter
virtual vtkObjectBaseNewInstanceInternal () 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 ()
 
- 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

char * FileName
 
FILE * FileFD
 
vtkTypeBool ComputeNormals
 
- Protected Attributes inherited from vtkImporter
vtkRendererRenderer
 
vtkRenderWindowRenderWindow
 
vtkSmartPointer< vtkDataAssemblySceneHierarchy
 
- 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

- 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

imports 3D Studio files.

vtk3DSImporter imports 3D Studio files into vtk.

See also
vtkImporter
Online Examples:

Tests:
vtk3DSImporter (Tests)

Definition at line 65 of file vtk3DSImporter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 70 of file vtk3DSImporter.h.

Constructor & Destructor Documentation

◆ vtk3DSImporter()

vtk3DSImporter::vtk3DSImporter ( )
protected

◆ ~vtk3DSImporter()

vtk3DSImporter::~vtk3DSImporter ( )
overrideprotected

Member Function Documentation

◆ New()

static vtk3DSImporter * vtk3DSImporter::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtk3DSImporter::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 vtk3DSImporter * vtk3DSImporter::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtk3DSImporter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImporter.

◆ NewInstance()

vtk3DSImporter * vtk3DSImporter::NewInstance ( ) const

◆ PrintSelf()

void vtk3DSImporter::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 vtkObjectBase.

◆ vtkSetFilePathMacro()

vtk3DSImporter::vtkSetFilePathMacro ( FileName  )

Specify the name of the file to read.

◆ vtkGetFilePathMacro()

vtk3DSImporter::vtkGetFilePathMacro ( FileName  )

Specify the name of the file to read.

◆ SetComputeNormals()

virtual void vtk3DSImporter::SetComputeNormals ( vtkTypeBool  )
virtual

Set/Get the computation of normals.

If on, imported geometry will be run through vtkPolyDataNormals.

◆ GetComputeNormals()

virtual vtkTypeBool vtk3DSImporter::GetComputeNormals ( )
virtual

Set/Get the computation of normals.

If on, imported geometry will be run through vtkPolyDataNormals.

◆ ComputeNormalsOn()

virtual void vtk3DSImporter::ComputeNormalsOn ( )
virtual

Set/Get the computation of normals.

If on, imported geometry will be run through vtkPolyDataNormals.

◆ ComputeNormalsOff()

virtual void vtk3DSImporter::ComputeNormalsOff ( )
virtual

Set/Get the computation of normals.

If on, imported geometry will be run through vtkPolyDataNormals.

◆ GetOutputsDescription()

std::string vtk3DSImporter::GetOutputsDescription ( )
overridevirtual

Get a printable string describing the outputs.

Reimplemented from vtkImporter.

◆ GetFileFD()

FILE * vtk3DSImporter::GetFileFD ( )
inline

Return the file pointer to the open file.

Definition at line 99 of file vtk3DSImporter.h.

◆ ImportBegin()

int vtk3DSImporter::ImportBegin ( )
overrideprotectedvirtual

Reimplemented from vtkImporter.

◆ ImportEnd()

void vtk3DSImporter::ImportEnd ( )
overrideprotectedvirtual

Reimplemented from vtkImporter.

◆ ImportActors()

void vtk3DSImporter::ImportActors ( vtkRenderer renderer)
overrideprotectedvirtual

Reimplemented from vtkImporter.

◆ ImportCameras()

void vtk3DSImporter::ImportCameras ( vtkRenderer renderer)
overrideprotectedvirtual

Reimplemented from vtkImporter.

◆ ImportLights()

void vtk3DSImporter::ImportLights ( vtkRenderer renderer)
overrideprotectedvirtual

Reimplemented from vtkImporter.

◆ ImportProperties()

void vtk3DSImporter::ImportProperties ( vtkRenderer renderer)
overrideprotectedvirtual

Reimplemented from vtkImporter.

◆ GeneratePolyData()

vtkPolyData * vtk3DSImporter::GeneratePolyData ( vtk3DSMesh *  meshPtr)
protected

◆ Read3DS()

int vtk3DSImporter::Read3DS ( )
protected

Member Data Documentation

◆ OmniList

vtk3DSOmniLight* vtk3DSImporter::OmniList

Definition at line 101 of file vtk3DSImporter.h.

◆ SpotLightList

vtk3DSSpotLight* vtk3DSImporter::SpotLightList

Definition at line 102 of file vtk3DSImporter.h.

◆ CameraList

vtk3DSCamera* vtk3DSImporter::CameraList

Definition at line 103 of file vtk3DSImporter.h.

◆ MeshList

vtk3DSMesh* vtk3DSImporter::MeshList

Definition at line 104 of file vtk3DSImporter.h.

◆ MaterialList

vtk3DSMaterial* vtk3DSImporter::MaterialList

Definition at line 105 of file vtk3DSImporter.h.

◆ MatPropList

vtk3DSMatProp* vtk3DSImporter::MatPropList

Definition at line 106 of file vtk3DSImporter.h.

◆ FileName

char* vtk3DSImporter::FileName
protected

Definition at line 121 of file vtk3DSImporter.h.

◆ FileFD

FILE* vtk3DSImporter::FileFD
protected

Definition at line 122 of file vtk3DSImporter.h.

◆ ComputeNormals

vtkTypeBool vtk3DSImporter::ComputeNormals
protected

Definition at line 123 of file vtk3DSImporter.h.


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