Referência ao ficheiro src/vapiOperationOptions.h

This file stores some low level functions to handle operation's custom options. Mais...

#include "vapiTypes.h"
#include "vapiOptions.h"
#include "vapiOperation.h"
#include "vapiImages.h"

Diagrama de dependências de inclusão para vapiOperationOptions.h:

Este grafo mostra quais são os ficheiros que incluem directamente ou indirectamente este ficheiro:

Ir para o código fonte deste ficheiro.

Funções
void	vapiCheckOptOriginal (vImages *Images, vOptions *Options)
	Check if the Original is set to true. This is a custom option, only in use by operations. This checks if the original is set to true and makes the operation use the original image if so.
vOptions *	vapiOperationOptionsInit (vEffect *Operation)
	Initiates an Custom Options structure.
vOptions *	vapiOptionsCopy (vEffect *Operation, vOptions *Options)
	Creates a copy of supplied Operation's options data structure.
IplImage *	vapiOptionsGetTemplate (vOptions *Options)
	fetches the template from the options data. This function is used to access the options data and avoid errors.
void	vEffectOptionsFree (vOptions *Options, vOptionsSettings *OptionsSettings)
	Frees the custom options used by the operation. This function is used from inside the free options general function.
void	vOperationOptionsFree (vOptions *Options, vEffect *Operation)
	Frees a complete Options data structure, including the custom operation options' data.
void	vOptionsFreeTemplate (vOptions *options)
	Frees a template form the Options data structure.

---

Descrição detalhada

This file stores some low level functions to handle operation's custom options.

Definido no ficheiro vapiOperationOptions.h.

---

Documentação das funções

void vapiCheckOptOriginal	(	vImages *	Images,
		vOptions *	Options
	)

Check if the Original is set to true. This is a custom option, only in use by operations. This checks if the original is set to true and makes the operation use the original image if so.

Parâmetros:

	Images	The image's handler
	Options	The options Data structure.

Definido na linha 44 do ficheiro vapiOperationOptions.c.

Referências _vOptions::CustomOptions, vapiOriginal2Actual() e vImagesFreeActual().

Referenciado por vapiApplyOperation() e vapiLaplace().

{
        if (((vEffectOptions *) Options->CustomOptions)->original)
        {
                vImagesFreeActual (Images);
                vapiOriginal2Actual (Images);
        }
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

vOptions* vapiOperationOptionsInit

(

vEffect *

Operation

)

Initiates an Custom Options structure.

Parâmetros:

Operation

so that the function can read the options settings and create the data struture has defined.

Retorna:

an options sata structure.

Definido na linha 11 do ficheiro vapiOperationOptions.c.

Referências _vOptions::CustomOptions, _vOptionsSettings::CustomOptionsSettings, _vEffectSettings::NeedOfAuxImage, NeedRegion, NeedTemplate, _vEffect::OptionsSettings, _vEffectOptions::original, _vEffectOptions::Template, _vEffectOptions::times, vapiOptionsInit() e vFALSE.

Referenciado por vapiCalibrateCameraCreateMacro(), vapiCalibrateCameraGetColourAOptions(), vapiCalibrateCameraGetColourBOptions(), vapiGtkMacroAppendItem(), vapiGtkMacroInsertItem(), vapiGtkMacroUpdateItemOptions(), vapiGtkOperationApply(), vapiGtkOperationShowOptions(), vapiMacroFromXML() e vapiOptionsCopy().

{
        vOptions *Options;
        vEffectOptions *CustomOptions;
        vEffectSettings *OperationSettings;

        /*
         * Pequena verificação de segurança.
         */
        if (Operation == NULL)
        {
                return NULL;
        }
        CustomOptions =
                malloc (sizeof (vEffectOptions));
        OperationSettings =
                Operation->OptionsSettings->CustomOptionsSettings;
        Options = vapiOptionsInit (Operation->OptionsSettings);
        Options->CustomOptions = CustomOptions;

        CustomOptions->original = vFALSE;
        CustomOptions->times = 1;

        if (OperationSettings->NeedOfAuxImage == NeedTemplate
            || OperationSettings->NeedOfAuxImage == NeedRegion)
        {
                CustomOptions->Template = NULL;
        }

        return Options;
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

vOptions* vapiOptionsCopy	(	vEffect *	Operation,
		vOptions *	Options
	)

Creates a copy of supplied Operation's options data structure.

Retorna:

a new Options data structure.

Definido na linha 82 do ficheiro vapiOperationOptions.c.

Referências _vOptions::booleans, _vOptionsSettings::booleansNumber, _vChar::ch, _vOptions::chars, _vOptionsSettings::charsNumber, _vOptions::choices, _vOptionsSettings::chooseNumber, _vOptions::floats, _vOptionsSettings::floatsNumber, _vOptions::ints, _vOptionsSettings::intsNumber, NeedRegion, NeedTemplate, _vEffect::OptionsSettings, vapiOperationOptionsInit() e vapiReturnStringPointer().

{
        vOptions *Options2;
        int i;

        Options2 = vapiOperationOptionsInit (Operation);

        /*
         * Pequena verificação de segurança.
         */
        if (Operation == NULL)
        {
                return NULL;
        }
        ((vEffectOptions *) Options2)->original =
                ((vEffectOptions *) Options)->original;
        ((vEffectOptions *) Options2)->times =
                ((vEffectOptions *) Options)->times;

        /*
         * Definição e alocação de espaço de acordo com as necessidades da operação.
         */
        if (Operation->OptionsSettings->floatsNumber)
        {
                for (i = 0; i < Operation->OptionsSettings->floatsNumber; i++)
                {
                        Options2->floats[i] = Options2->floats[i];
                }
        }
        if (Operation->OptionsSettings->intsNumber)
        {

                for (i = 0; i < Operation->OptionsSettings->intsNumber; i++)
                {
                        Options2->ints[i] = Options->ints[i];
                }
        }

        if (Operation->OptionsSettings->charsNumber)
        {
                for (i = 0; i < Operation->OptionsSettings->charsNumber; i++)
                {
                        Options2->chars[i].ch =
                                vapiReturnStringPointer (Options->chars[i].
                                                         ch);
                }
        }
        if (Operation->OptionsSettings->chooseNumber)
        {

                for (i = 0; i < Operation->OptionsSettings->chooseNumber; i++)
                {
                        Options2->choices[i] = Options->choices[i];
                }
        }
        if (Operation->OptionsSettings->booleansNumber)
        {

                for (i = 0; i < Operation->OptionsSettings->booleansNumber;
                     i++)
                {
                        Options2->booleans[i] = Options->booleans[i];
                }
        }
        if (((vEffectSettings *) Operation->OptionsSettings->
             CustomOptionsSettings)->NeedOfAuxImage == NeedTemplate
            || ((vEffectSettings *) Operation->OptionsSettings->
                CustomOptionsSettings)->NeedOfAuxImage == NeedRegion)
        {
                ((vEffectOptions *) Options2)->Template =
                        ((vEffectOptions *) Options)->Template;
        }

        return Options2;

}

Grafo de chamadas desta função:

IplImage* vapiOptionsGetTemplate

(

vOptions *

Options

)

fetches the template from the options data. This function is used to access the options data and avoid errors.

Retorna:

the IplImage pointer for the template.

Definido na linha 167 do ficheiro vapiOperationOptions.c.

Referências _vOptions::CustomOptions e _vEffectOptions::Template.

Referenciado por vapiTemplateMatch().

{
        vEffectOptions * OperationOptions = Options->CustomOptions;
        
        return OperationOptions->Template;
}

Here is the caller graph for this function:

void vEffectOptionsFree	(	vOptions *	Options,
		vOptionsSettings *	OptionsSettings
	)

Frees the custom options used by the operation. This function is used from inside the free options general function.

Definido na linha 54 do ficheiro vapiOperationOptions.c.

Referências _vOptions::CustomOptions, _vOptionsSettings::CustomOptionsSettings, _vEffectSettings::NeedOfAuxImage, NoNeed e vOptionsFreeTemplate().

Referenciado por vOperationOptionsFree().

{
        vEffectSettings *OperationSettings =
                OptionsSettings->CustomOptionsSettings;

        if (OperationSettings->NeedOfAuxImage != NoNeed)
        {
                vOptionsFreeTemplate (Options);
        }
        free (Options->CustomOptions);
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

void vOperationOptionsFree	(	vOptions *	Options,
		vEffect *	Operation
	)

Frees a complete Options data structure, including the custom operation options' data.

Definido na linha 160 do ficheiro vapiOperationOptions.c.

Referências _vEffect::OptionsSettings, vEffectOptionsFree() e vOptionsFree().

Referenciado por vapiGtkMacroUpdateItemOptions(), vapiGtkOperationApply(), vapiGtkOperationShowOptions() e vMacroItemFree().

{
        vOptionsFree (Options, Operation->OptionsSettings,
                      &vEffectOptionsFree);
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

void vOptionsFreeTemplate

(

vOptions *

options

)

Frees a template form the Options data structure.

Definido na linha 67 do ficheiro vapiOperationOptions.c.

Referências _vOptions::CustomOptions.

Referenciado por vEffectOptionsFree().

{
        if (!
            (((vEffectOptions *) options->CustomOptions)->Template ==
             NULL))
        {
                cvReleaseImage (&
                                ((vEffectOptions *) options->
                                 CustomOptions)->Template);

        }
}

Here is the caller graph for this function:

---