# cee::pt::PtfxDatasetReader

class `PtfxDatasetReader` : public ParticleDatasetReader

  ParticleDatasetReader implementation for the PTFX binary particle format.

  See also

  ParticleDatasetReader, PtfxDatasetWriter, VtpDatasetReader

  Public Functions

  `PtfxDatasetReader`()
  bool `open`(const Str &filePath, Error *error = nullptr) override

    Opens a PTFX dataset from the given file path.

    Note

    The dataset opens in positions-only mode &#8212; no scalar field is auto-activated. After a successful open(), call setActiveScalarField() to enable scalar coloring. The available field names can be queried with header().scalarFieldNames.

  bool `setActiveScalarField`(const Str &fieldName) override

    Sets the active scalar field to fieldName.

    See also

    clearActiveScalarField()

  Protected Functions

  std::unique_ptr<FrameData> `readFrame`(size_t frameIndex, const Str &activeScalar) override

    Reads a single PTFX frame at frameIndex and returns it as FrameData.

    This method is called without holding mutex(). Member fields read here (m_pimpl members and constHeader().scalarFieldNames) are set once in open() and never modified while isReaderOpen() is true.

  void `resetDerivedState`() override

    Resets PTFX-specific state (called by base class close())

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your multilingual generative AI assistant for documentation. Ask me anything about HOOPS Envision for Desktop in your own language, or choose a sample question below to start a conversation:

What is HOOPS Envision for Desktop?
What are the latest release notes for HOOPS Envision for Desktop?
How do I start evaluating HOOPS Envision for Desktop?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...