VTK  9.0.20201023
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. More...
 
vtk3DSImporterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetFileName (const char *)
 Specify the name of the file to read. More...
 
virtual char * GetFileName ()
 
virtual void SetComputeNormals (vtkTypeBool)
 Set/Get the computation of normals. More...
 
virtual vtkTypeBool GetComputeNormals ()
 
virtual void ComputeNormalsOn ()
 
virtual void ComputeNormalsOff ()
 
std::string GetOutputsDescription () override
 Get a printable string describing the outputs. More...
 
FILE * GetFileFD ()
 Return the file pointer to the open file. More...
 
- Public Member Functions inherited from vtkImporter
vtkImporterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkRendererGetRenderer ()
 Get the renderer that contains the imported actors, cameras and lights. More...
 
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. More...
 
virtual vtkRenderWindowGetRenderWindow ()
 
void Read ()
 Import the actors, cameras, lights and properties into a vtkRenderWindow. More...
 
void Update ()
 
virtual vtkIdType GetNumberOfAnimations ()
 Get the number of available animations. More...
 
virtual std::string GetAnimationName (vtkIdType vtkNotUsed(animationIndex))
 Get the name of an animation. More...
 
virtual void EnableAnimation (vtkIdType vtkNotUsed(animationIndex))
 Enable/Disable/Get the status of specific animations. More...
 
virtual void DisableAnimation (vtkIdType vtkNotUsed(animationIndex))
 
virtual bool IsAnimationEnabled (vtkIdType vtkNotUsed(animationIndex))
 
virtual bool GetTemporalInformation (vtkIdType animationIndex, double frameRate, int &nbTimeSteps, double timeRange[2], vtkDoubleArray *timeSteps)
 Get temporal informations for the currently enabled animations. More...
 
virtual void UpdateTimeStep (double timeStep)
 Import the actors, camera, lights and properties at a specific timestep. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

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. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

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
 vtkImporter ()
 
 ~vtkImporter () override
 
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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

char * FileName
 
FILE * FileFD
 
vtkTypeBool ComputeNormals
 
- Protected Attributes inherited from vtkImporter
vtkRendererRenderer
 
vtkRenderWindowRenderWindow
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- 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

Definition at line 34 of file vtk3DSImporter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 39 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 vtkObject.

◆ SetFileName()

virtual void vtk3DSImporter::SetFileName ( const char *  )
virtual

Specify the name of the file to read.

◆ GetFileName()

virtual char* vtk3DSImporter::GetFileName ( )
virtual

◆ 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

◆ ComputeNormalsOn()

virtual void vtk3DSImporter::ComputeNormalsOn ( )
virtual

◆ ComputeNormalsOff()

virtual void vtk3DSImporter::ComputeNormalsOff ( )
virtual

◆ 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 68 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 70 of file vtk3DSImporter.h.

◆ SpotLightList

vtk3DSSpotLight* vtk3DSImporter::SpotLightList

Definition at line 71 of file vtk3DSImporter.h.

◆ CameraList

vtk3DSCamera* vtk3DSImporter::CameraList

Definition at line 72 of file vtk3DSImporter.h.

◆ MeshList

vtk3DSMesh* vtk3DSImporter::MeshList

Definition at line 73 of file vtk3DSImporter.h.

◆ MaterialList

vtk3DSMaterial* vtk3DSImporter::MaterialList

Definition at line 74 of file vtk3DSImporter.h.

◆ MatPropList

vtk3DSMatProp* vtk3DSImporter::MatPropList

Definition at line 75 of file vtk3DSImporter.h.

◆ FileName

char* vtk3DSImporter::FileName
protected

Definition at line 90 of file vtk3DSImporter.h.

◆ FileFD

FILE* vtk3DSImporter::FileFD
protected

Definition at line 91 of file vtk3DSImporter.h.

◆ ComputeNormals

vtkTypeBool vtk3DSImporter::ComputeNormals
protected

Definition at line 92 of file vtk3DSImporter.h.


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