1. Epic GamesDeveloper
  3. FNodalOffsetTable

FNodalOffsetTable

Table containing nodal offset mapping to focus and zoom

API > API/Plugins > API/Plugins/CameraCalibrationCore

Table containing nodal offset mapping to focus and zoom

   
Name FNodalOffsetTable
Type struct
Header File /Engine/Plugins/VirtualProduction/CameraCalibrationCore/Source/CameraCalibrationCore/Public/Tables/NodalOffsetTable.h
Include Path #include "Tables/NodalOffsetTable.h"

Syntax

USTRUCT ()  
struct FNodalOffsetTable : public FBaseLensTable

Inheritance Hierarchy

Structs

Name Remarks
FParameters Wrapper for indices of specific parameters for the nodal offset table

Typedefs

Name Type Remarks Include Path
FocusCurveType FNodalOffsetFocusCurve   Tables/NodalOffsetTable.h
FocusPointType FNodalOffsetFocusPoint   Tables/NodalOffsetTable.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
FocusCurves TArray< FNodalOffsetFocusCurve > A list of curves along the focus axis for each zoom value Tables/NodalOffsetTable.h  
FocusPoints TArray< FNodalOffsetFocusPoint > Lists of focus points Tables/NodalOffsetTable.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddPoint ( float InFocus,
float InZoom,
const FNodalPointOffset& InData,
float InputTolerance,
bool bIsCalibrationPoint
)

 Adds a new point in the table Tables/NodalOffsetTable.h  

void BuildFocusCurves()

 Builds the focus curves to match existing data in the table Tables/NodalOffsetTable.h  

virtual bool CanEditCurveKeyPositions ( int32 InParameterIndex
) const

   Tables/NodalOffsetTable.h  

void ChangeFocusPoint ( float InExistingFocus,
float InNewFocus,
float InputTolerance
)

 Changes the value of a focus point Tables/NodalOffsetTable.h  

void ChangeZoomPoint ( float InFocus,
float InExistingZoom,
float InNewZoom,
float InputTolerance
)

 Changes the value of a zoom point Tables/NodalOffsetTable.h  

virtual void ForEachPoint ( FFocusPointCallback InCallback
) const

   Tables/NodalOffsetTable.h  

FNodalOffsetFocusCurve * GetFocusCurve ( float InZoom,
float InputTolerance
)

 Gets the focus curve for the specified zoom, or nullptr if none were found Tables/NodalOffsetTable.h  

const FNodalOffsetFocusCurve * GetFocusCurve ( float InZoom,
float InputTolerance
) const

 Gets the focus curve for the specified zoom, or nullptr if none were found Tables/NodalOffsetTable.h  
Returns all focus curves Tables/NodalOffsetTable.h  

TConstArrayView< FNodalOffsetFocusCurve > GetFocusCurves ()

 Returns all focus curves Tables/NodalOffsetTable.h  

FNodalOffsetFocusPoint * GetFocusPoint ( float InFocus,
float InputTolerance
)

 Returns point for a given focus Tables/NodalOffsetTable.h  

const FNodalOffsetFocusPoint * GetFocusPoint ( float InFocus,
float InputTolerance
) const

 Returns const point for a given focus Tables/NodalOffsetTable.h  
Returns all focus points Tables/NodalOffsetTable.h  

TConstArrayView< FNodalOffsetFocusPoint > GetFocusPoints ()

 Returns all focus points Tables/NodalOffsetTable.h  

bool GetPoint ( const float InFocus,
const float InZoom,
FNodalPointOffset& OutData,
float InputTolerance
) const

 Get the point from the table Tables/NodalOffsetTable.h  

bool HasFocusPoint ( float InFocus,
float InputTolerance
) const

 Checks to see if there exists a focus point matching the specified focus value Tables/NodalOffsetTable.h  

bool HasZoomPoint ( float InFocus,
float InZoom,
float InputTolerance
)

 Checks to see if there exists a zoom point matching the specified zoom and focus values Tables/NodalOffsetTable.h  

void MergeFocusPoint ( float InSrcFocus,
float InDestFocus,
bool bReplaceExistingZoomPoints,
float InputTolerance
)

 Merges the points in the specified source focus into the specified destination focus Tables/NodalOffsetTable.h  

void RemoveFocusPoint ( float InFocus
)

 Removes a focus point identified as InFocusIdentifier Tables/NodalOffsetTable.h  

void RemoveZoomPoint ( float InFocus,
float InZoom
)

 Removes a zoom point from a focus point Tables/NodalOffsetTable.h  

virtual void SetParameterCurveKeysAtFocus ( float InFocus,
int32 InParameterIndex,
const FRichCurve& InSourceCurve,
TArrayView< const FKeyHandle > InKeys
)

   Tables/NodalOffsetTable.h  

virtual void SetParameterCurveKeysAtZoom ( float InZoom,
int32 InParameterIndex,
const FRichCurve& InSourceCurve,
TArrayView< const FKeyHandle > InKeys
)

   Tables/NodalOffsetTable.h  

bool SetPoint ( float InFocus,
float InZoom,
const FNodalPointOffset& InData,
float InputTolerance
)

 Set a new point into the table Tables/NodalOffsetTable.h  

Overridden from FBaseLensTable

Name Remarks Include Path Unreal Specifiers

virtual bool BuildParameterCurveAtFocus ( float InFocus,
int32 ParameterIndex,
FRichCurve& OutCurve
) const

 Fills OutCurve with all points contained in the given focus Returns false if FocusIdentifier is not found or ParameterIndex isn't valid Tables/NodalOffsetTable.h  

virtual bool BuildParameterCurveAtZoom ( float InZoom,
int32 ParameterIndex,
FRichCurve& OutCurve
) const

 Fills OutCurve with points across all focuses that have the given zoom Tables/NodalOffsetTable.h  

virtual bool CanEditCurveKeyAttributes ( int32 InParameterIndex
) const

 Gets whether the attributes of the table's curve keys can be edited or not Tables/NodalOffsetTable.h  

virtual int32 GetFocusPointNum()

 Loop through all Focus Points Tables/NodalOffsetTable.h  

virtual FText GetParameterValueLabel ( int32 InParameterIndex
) const

 Gets the text to display on any UI when labeling the values of this table's parameters Tables/NodalOffsetTable.h  

virtual FText GetParameterValueUnitLabel ( int32 InParameterIndex
) const

 Gets the text to display on any UI when displaying units of the values of this table's parameters Tables/NodalOffsetTable.h  

virtual UScriptStruct * GetScriptStruct()

 Get Struct class of this Data Table Tables/NodalOffsetTable.h  

virtual int32 GetTotalPointNum()

 Get total number of Zoom points for all Focus points of this data table Tables/NodalOffsetTable.h  

Protected

Overridden from FBaseLensTable

Name Remarks Include Path Unreal Specifiers

virtual bool DoesFocusPointExists ( float InFocus,
float InputTolerance
) const

 Whether the focus point exists Tables/NodalOffsetTable.h  

virtual bool DoesZoomPointExists ( float InFocus,
float InZoom,
float InputTolerance
) const

 Whether the zoom point exists Tables/NodalOffsetTable.h  

virtual const FBaseFocusPoint * GetBaseFocusPoint ( int32 InIndex
) const

 Get the base focus point by given index Tables/NodalOffsetTable.h  

virtual TMap< ELensDataCategory, FLinkPointMetadata > GetLinkedCategories()

 Returns the map of linked categories Tables/NodalOffsetTable.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page